chore: best practices

.github/workflows/python-publish.yml

@@ -10,16 +10,20 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.x"
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install build
+
       - name: Build package
         run: python -m build
+
       - name: Publish package
         uses: pypa/gh-action-pypi-publish@81e9d935c883d0b210363ab89cf05f3894778450
         with:

.github/workflows/python-test.yml

@@ -33,20 +33,20 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -r requirements.txt
-          python -m pip install -e .[dev]
+          python -m pip install -r requirements.txt -r requirements-dev.txt
 
-      - name: Lint with flake8
+      - name: Linting and formatting with ruff
         run: |
-          flake8 . --count --show-source --statistics
+          ruff check .
+          ruff format . --diff
 
-      - name: Check typing with mypy
+      - name: Linting with pyright
         run: |
-          mypy --install-types --non-interactive .
+          pyright --warnings --project pyproject.toml
 
-      - name: Check syntax with pyupgrade
+      - name: Dependency scanning with safety
         run: |
-          find . -type f -regex '.*\.py$' -exec pyupgrade --py39-plus {} \;
+          safety --disable-optional-telemetry check -r requirements.txt --full-report
 
       - name: Create k8s Kind Cluster
         uses: helm/[email protected]

.gitignore

@@ -1,40 +1,33 @@
-node_modules
-dist
-.tmp
-.sass-cache
-bower_components
-.noseids
-
-# Generated by pip / easy_install
-/docs
-/man
-/tests
-/share
+# Gitignore copy pasted from github
+# https://github.com/github/gitignore/tree/main
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
+*$py.class
 
 # C extensions
 *.so
 
 # Distribution / packaging
 .Python
-env/
 build/
 develop-eggs/
 dist/
 downloads/
 eggs/
+.eggs/
 lib/
 lib64/
 parts/
 sdist/
 var/
-.idea/
+wheels/
+share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+MANIFEST
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -49,31 +42,164 @@ 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
 
 # Django stuff:
 *.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
 
 # Sphinx documentation
-documentation/build/
-documentation/source/_build/
+docs/_build/
 
 # PyBuilder
+.pybuilder/
 target/
 
-# Vi
-*.swp
+# Jupyter Notebook
+.ipynb_checkpoints
 
-# Mypy
-.mypy_cache/
+# IPython
+profile_default/
+ipython_config.py
 
-# Venv
-venv/
+# 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
+
+# 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
+
+# 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/#use-with-ide
+.pdm.toml
+
+# 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/
+
+# Custom part
+## Python
+pytest.ini
+.ruff_cache
+.debug.py
+pyrightconfig.json
+configuration.yaml
+coverage.json
+metrics.txt
+src/tests
+*.po~
+alembic/alembic.ini
+venv-python*
+venv*
+junit.xml
+
+## GraphQL
+graphql-schema.graphql
+.graphqlconfig
+schema.graphql
+
+## Gitlab CI
+.gitlab-ci-local
+
+## mayo
+mayo-complete.sh
+
+## macOS
+.DS_Store
+
+## Other
+.vscode/
+*.swp
+.debug/
+.tmp
+.direnv
+.envrc
+notes/
+samples/
+.optimization_debug/
+.run/

.safety-policy.yml

@@ -0,0 +1,12 @@
+# Safety Security and License Configuration file
+# We recommend checking this file into your source control in the root of your Python project
+# If this file is named .safety-policy.yml and is in the same directory where you run `safety check` it will be used by default.
+# Otherwise, you can use the flag `safety check --policy-file <path-to-this-file>` to specify a custom location and name for the file.
+# To validate and review your policy file, run the validate command: `safety validate policy_file --path <path-to-this-file>`
+security: # configuration for the `safety check` command
+    ignore-cvss-severity-below: 0 # A severity number between 0 and 10. Some helpful reference points: 9=ignore all vulnerabilities except CRITICAL severity. 7=ignore all vulnerabilities except CRITICAL & HIGH severity. 4=ignore all vulnerabilities except CRITICAL, HIGH & MEDIUM severity.
+    ignore-cvss-unknown-severity: True # True or False. We recommend you set this to False.
+    ignore-vulnerabilities: # Here you can list multiple specific vulnerabilities you want to ignore (optionally for a time period)
+        45114:
+            reason: "Vulnerability found in kubernetes version 24.2.0"
+            expires: '2024-12-01'