Merge pull request #29 from mts-ai/feature/create-relationships-on-object-creation

Generic views, process relationships; + refactoring

Author: mahenzon

.coveragerc

@@ -1,5 +1,6 @@
 # .coveragerc to control coverage.py
 [run]
+concurrency = greenlet
 branch = True
 omit =
     tests/*
@@ -26,10 +27,14 @@ exclude_also =
     # Don't complain if non-runnable code isn't run:
     if 0:
     if __name__ == .__main__.:
+    if TYPE_CHECKING:
 
     # Don't complain about abstract methods, they aren't run:
     @(abc\.)?abstractmethod
 
+    # no cover
+    pragma: no cover
+
 ignore_errors = True
 
 [html]

.github/workflows/documentation.yaml

@@ -3,14 +3,16 @@
 name: 📖 Docs
 on:
   - push
-  - pull_request
-  - workflow_dispatch
+#  - pull_request
+#  - workflow_dispatch
 
 permissions:
   contents: write
 
 jobs:
   docs:
+#    if: ${{ !github.event.act }} # skip during local actions testing
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -23,7 +25,7 @@ jobs:
           sphinx-build docs _build
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
-        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+#        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
         with:
           publish_branch: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/python-publish.yml

@@ -9,6 +9,7 @@ permissions:
 
 jobs:
   pypi-publish:
+    if: ${{ !github.event.act }} # skip during local actions testing
 
     runs-on: ubuntu-latest
 

.github/workflows/testing.yml

@@ -1,16 +1,21 @@
 name: Python testing
 
 on:
-  - push
+  push:
+#  pull_request:
+
+# is there a way to fix doubled pipelines?
+# only XXX
+# https://github.com/orgs/community/discussions/25654
+# https://github.com/orgs/community/discussions/26276
 
 jobs:
-  check:
+  lint:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version:
           - "3.9"
-          - "3.10"
           - "3.11"
 
     steps:
@@ -27,5 +32,53 @@ jobs:
         run: poetry install --all-extras
       - name: Lint code
         run: pre-commit run --all-files
+
+
+  run-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+        db-url:
+          - "sqlite+aiosqlite:///./db.sqlite3"
+          - "postgresql+asyncpg://user:passwd@localhost:5432/app"
+
+    # Service containers to run with `container-job`
+    services:
+      # Label used to access the service container
+      postgres:
+        # Docker Hub image
+        image: postgres
+        # Provide the password for postgres
+        env:
+          POSTGRES_USER: user
+          POSTGRES_PASSWORD: passwd
+          POSTGRES_DB: app
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          # Maps tcp port 5432 on service container to the host
+          - 5432:5432
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install poetry
+        run: |
+          python -m pip install --upgrade pip poetry pre-commit
+          poetry config virtualenvs.create false --local
+      - name: Install dependencies
+        run: poetry install --all-extras
       - name: Test with pytest
         run: pytest -s -vv tests/
+        env:
+          TESTING_DB_URL: ${{ matrix.db-url }}

.gitignore

@@ -1,10 +1,170 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# 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
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# 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/
+
 /.python-version
 /examples/api_for_tortoise_orm/db.sqlite3
 /examples/api_for_tortoise_orm/db.sqlite3-shm
 /examples/api_for_tortoise_orm/db.sqlite3-wal
 /db.sqlite3
 /db.sqlite3-shm
 /db.sqlite3-wal
-/.idea
 /examples/api_for_sqlalchemy/db.sqlite3
-/dist/
+.DS_Store