Merge pull request #158 from dclimber/feature/poetry

Feature/poetry

.github/workflows/pytest.yml

@@ -32,11 +32,14 @@ jobs:
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
       with:
-        python-version:  ${{ matrix.python-version }}
+        python-version: ${{ matrix.python-version }}
+    - name: Install poetry
+      uses: snok/install-poetry@v1
+      with:
+        virtualenvs-create: true
+        virtualenvs-in-project: true
     - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r tests/dev.requirements.txt
+      run: poetry install --no-interaction --no-root
     - name: Test with pytest
       env:
         POSTGRES_DB: test
@@ -45,4 +48,5 @@ jobs:
         POSTGRES_HOST: localhost
         POSTGRES_PORT: ${{ job.services.postgres.ports[5432] }}
       run: |
+        source .venv/bin/activate
         pytest

docs/en/docs/backends/tortoise.md

@@ -5,6 +5,9 @@ your database using your [Tortoise](https://tortoise-orm.readthedocs.io/en/lates
 !!! warning
     To use the `TortoiseCRUDRouter`, [Tortoise ORM](https://pypi.org/project/tortoise-orm/) must be first installed.
 
+!!! warning
+    Tortoise ORM works on python versions 3.7 and higher, so if you want to use this backend, you would not be able to use `python 3.6`.
+
 ## Simple Example
 Below is an example assuming that you have already imported and created all the required models.
 

docs/en/docs/contributing.md

@@ -14,6 +14,20 @@ on the feature and potential help on where to start implementation wise.
 
 ## Development
 
+### Using [poetry](https://python-poetry.org/)
+
+FastAPI-Crudrouter uses [poetry](https://python-poetry.org/) as depenency management system. To install all of the required dependecies simply run:
+
+    poetry install
+
+Both dev-requirements and project-requirements will be installed with this command.
+
+To enter the virtual-environment created with poetry use:
+
+    poetry shell
+
+If you are not familiar with poetry, please read their [usage guide](https://python-poetry.org/docs/basic-usage/).
+
 ### Installing the Dev Requirements
 FastAPI-Crudrouter requires as set of development requirements that can installed with `pip` be found in `tests/dev.requirements.txt`