Merge pull request #92 from trubrics/feat/new_python_sdk_structure

New python SDK structure

.github/workflows/checks.yml

@@ -0,0 +1,29 @@
+name: Checks code quality
+
+on: [push]
+
+jobs:
+  code-checks:
+    name: Checks quality of code
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Install uv and setup Python version
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "0.5.26"
+
+    - name: Set up Python
+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Setup uv venv
+      run: |
+        uv venv && source .venv/bin/activate && make install_dev_requirements
+
+    - name: Run pre-commit hooks
+      uses: pre-commit/action@v3.0.1

.github/workflows/release.yml

@@ -1,46 +1,55 @@
-name: Release package
+name: Release and Publish
 
 on:
   push:
     tags:
       - v*
 
 jobs:
-  build-and-publish:
-    name: Build and publish Python dist to PyPI
+  release:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
+
+    - name: Install uv and setup Python version
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "0.5.26"
+
+    - name: Set up Python
+      run: uv python install 3.10
+
+    - name: Setup uv venv
+      run: |
+        uv venv && source .venv/bin/activate && make install_dev_requirements
+
+    - name: Get version from pyproject.toml
+      id: get_version
+      run: |
+        echo "VERSION=$(awk -F'"' '/^version/ {print $2}' pyproject.toml)" >> $GITHUB_ENV
+
     - name: Extract release notes
       id: extract-release-notes
       uses: ffurrer2/extract-release-notes@v1
-    - name: Create github release
-      if: startsWith(github.ref, 'refs/tags')
-      uses: softprops/action-gh-release@v1
+
+    - name: Create GitHub Release
+      uses: actions/create-release@v1
       with:
+        tag_name: "v${{ env.VERSION }}"
         body: ${{ steps.extract-release-notes.outputs.release_notes }}
-        files: dist/*.whl
-    - name: Set up Python 3.9
-      uses: actions/setup-python@v3
-      with:
-        python-version: "3.9"
-    - name: Install pypa/build
-      run: >-
-        python -m
-        pip install
-        build
-        --user
-    - name: Build a binary wheel and a source tarball
-      run: >-
-        python -m
-        build
-        --sdist
-        --wheel
-        --outdir dist/
-        .
-    - name: Publish distribution 📦 to PyPI
-      if: startsWith(github.ref, 'refs/tags')
-      uses: pypa/gh-action-pypi-publish@master
-      with:
-        password: ${{ secrets.PYPI_API_TOKEN }}
+        release_name: "Release ${{ env.VERSION }}"
+        draft: false
+        prerelease: false
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Build package
+      run: |
+        uv build
+
+    - name: Publish to PyPI
+      run: |
+        uv publish
+      env:
+        UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -1,39 +1,171 @@
-# pycache
-__pycache__
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
 
-# local builds
-*.egg-info
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
 dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
 
-# mac stuff
-.DS_Store
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
 
-# venv
-venv
+# Flask stuff:
+instance/
+.webassets-cache
 
-# notebook stuff
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
 .ipynb_checkpoints
 
-# mypy
-.mypy_cache
-typings/
+# IPython
+profile_default/
+ipython_config.py
 
-# my scrap folder
-scrap
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
 
-# IDE
-.vscode
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
 
-# docs
-docs/build
-docs/data
-docs/models
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
 
-# tests
-.coverage
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
 
-# env variables
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
 .env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
 
-# streamlit secrets
-.streamlit
+# PyPI configuration file
+.pypirc