Merge branch 'release/3.2.0'

Author: s3rius

.github/workflows/test.yml

@@ -8,7 +8,22 @@ on:
       - "*"
 
 jobs:
+  pre_job:
+    # continue-on-error: true # Uncomment once integration is finished
+    runs-on: ubuntu-latest
+    # Map a step output to a job output
+    outputs:
+      should_skip: ${{ steps.skip_check.outputs.should_skip }}
+    steps:
+      - id: skip_check
+        uses: fkirc/skip-duplicate-actions@master
+        with:
+          # All of these options are optional, so you can remove them if you are happy with the defaults
+          concurrent_skipping: 'same_content'
+          skip_after_successful_duplicate: 'true'
   pytest:
+    needs: pre_job
+    if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

fastapi_template/cli.py

@@ -187,6 +187,7 @@ def read_user_input(current_context: BuilderContext) -> BuilderContext:
     if current_context.db == DatabaseType.none:
         current_context.enable_migrations = False
         current_context.add_dummy = False
+        current_context.orm == ORM.none
     elif current_context.orm is None:
         current_context.orm = radiolist_dialog(
             "ORM",

fastapi_template/input_model.py

@@ -20,6 +20,8 @@ class CIType(enum.Enum):
 
 @enum.unique
 class ORM(enum.Enum):
+    none = "none"
+    ormar = "ormar"
     sqlalchemy = "sqlalchemy"
     tortoise = "tortoise"
 
@@ -29,6 +31,7 @@ class Database(BaseModel):
     image: Optional[str]
     driver: Optional[str]
     async_driver: Optional[str]
+    driver_short: Optional[str]
     port: Optional[int]
 
 
@@ -44,20 +47,23 @@ class Database(BaseModel):
         name=DatabaseType.postgresql.value,
         image="postgres:13.4-buster",
         async_driver="postgresql+asyncpg",
-        driver="postgres",
+        driver_short="postgres",
+        driver="postgresql",
         port=5432,
     ),
     DatabaseType.mysql: Database(
         name=DatabaseType.mysql.value,
         image="bitnami/mysql:8.0.26",
         async_driver="mysql+aiomysql",
+        driver_short="mysql",
         driver="mysql",
         port=3306,
     ),
     DatabaseType.sqlite: Database(
         name=DatabaseType.sqlite.value,
         image=None,
         async_driver="sqlite+aiosqlite",
+        driver_short="sqlite",
         driver="sqlite",
         port=None,
     ),

fastapi_template/template/{{cookiecutter.project_name}}/.pre-commit-config.yaml

@@ -58,6 +58,9 @@ repos:
             entry: poetry run mypy
             language: system
             types: [python]
+            pass_filenames: false
+            args:
+              - "{{cookiecutter.project_name}}"
 
           - id: yesqa
             name: Remove usless noqa

fastapi_template/template/{{cookiecutter.project_name}}/README.md

@@ -37,7 +37,7 @@ docker save --output {{cookiecutter.project_name}}.tar {{cookiecutter.project_na
 
 If you want to migrate your database, you should run following commands:
 ```bash
-{%- if cookiecutter.orm == 'sqlalchemy' %}
+{%- if cookiecutter.orm in ['sqlalchemy', 'ormar'] %}
 # To run all migrations untill the migration with revision_id.
 alembic upgrade "<revision_id>"
 
@@ -53,7 +53,7 @@ aerich upgrade
 
 If you want to revert migrations, you should run:
 ```bash
-{%- if cookiecutter.orm == 'sqlalchemy' %}
+{%- if cookiecutter.orm in ['sqlalchemy', 'ormar'] %}
 # revert all migrations up to: revision_id.
 alembic downgrade <revision_id>
 
@@ -68,7 +68,7 @@ aerich downgrade
 
 To generate migrations you should run:
 ```bash
-{%- if cookiecutter.orm == 'sqlalchemy' %}
+{%- if cookiecutter.orm in ['sqlalchemy', 'ormar'] %}
 # For automatic change detection.
 alembic revision --autogenerate
 

fastapi_template/template/{{cookiecutter.project_name}}/conditional_files.json

@@ -37,9 +37,16 @@
             "aerich.ini",
             "alembic.ini",
             "{{cookiecutter.project_name}}/db_sa/migrations",
+            "{{cookiecutter.project_name}}/db_ormar/migrations",
             "{{cookiecutter.project_name}}/db_tortoise/migrations"
         ]
     },
+    "Alembic migrations": {
+        "enabled": "{{cookiecutter.orm in ['ormar', 'sqlalchemy']}}",
+        "resources": [
+            "alembic.ini"
+        ]
+    },
     "Gitlab CI": {
         "enabled": "{{cookiecutter.ci_type == 'gitlab_ci'}}",
         "resources": [
@@ -69,10 +76,13 @@
             "{{cookiecutter.project_name}}/web/api/dummy",
             "{{cookiecutter.project_name}}/db_sa/dao",
             "{{cookiecutter.project_name}}/db_sa/models/dummy_model.py",
+            "{{cookiecutter.project_name}}/db_ormar/dao",
+            "{{cookiecutter.project_name}}/db_ormar/models/dummy_model.py",
             "{{cookiecutter.project_name}}/db_tortoise/dao",
             "{{cookiecutter.project_name}}/db_tortoise/models/dummy_model.py",
             "{{cookiecutter.project_name}}/tests/test_dummy.py",
             "{{cookiecutter.project_name}}/db_sa/migrations/versions/2021-08-16-16-55_2b7380507a71.py",
+            "{{cookiecutter.project_name}}/db_ormar/migrations/versions/2021-08-16-16-55_2b7380507a71.py",
             "{{cookiecutter.project_name}}/db_tortoise/migrations/models/1_20210928165300_init_dummy_pg.sql",
             "{{cookiecutter.project_name}}/db_tortoise/migrations/models/1_20210928165300_init_dummy_mysql.sql",
             "{{cookiecutter.project_name}}/db_tortoise/migrations/models/1_20210928165300_init_dummy_sqlite.sql"
@@ -88,7 +98,6 @@
     "SQLAlchemy ORM": {
         "enabled": "{{cookiecutter.orm == 'sqlalchemy'}}",
         "resources": [
-            "alembic.ini",
             "{{cookiecutter.project_name}}/db_sa"
         ]
     },
@@ -99,6 +108,12 @@
             "{{cookiecutter.project_name}}/db_tortoise"
         ]
     },
+    "Ormar ORM": {
+        "enabled": "{{cookiecutter.orm == 'ormar'}}",
+        "resources": [
+            "{{cookiecutter.project_name}}/db_ormar"
+        ]
+    },
     "Postgresql DB": {
         "enabled": "{{cookiecutter.db_info.name == 'postgresql'}}",
         "resources": [

fastapi_template/template/{{cookiecutter.project_name}}/deploy/Dockerfile

@@ -1,5 +1,11 @@
 FROM python:3.9.6-slim-buster
 
+{% if cookiecutter.db_info.name == "mysql" -%}
+RUN apt-get update && apt-get install -y \
+  default-libmysqlclient-dev \
+  gcc \
+  && rm -rf /var/lib/apt/lists/*
+{%- endif %}
 
 RUN pip install poetry==1.1.8
 
@@ -13,6 +19,13 @@ WORKDIR /app/src
 # Installing requirements
 RUN poetry install
 
+{%- if cookiecutter.db_info.name == "mysql" %}
+# Removing gcc
+RUN apt-get purge -y \
+  gcc \
+  && rm -rf /var/lib/apt/lists/*
+{%- endif %}
+
 # Copying actuall application
 COPY . /app/src/
 RUN poetry install

fastapi_template/template/{{cookiecutter.project_name}}/deploy/docker-compose.yml

@@ -93,7 +93,7 @@ services:
   migrator:
     image: {{cookiecutter.project_name}}:{{"${" }}{{cookiecutter.project_name | upper }}_VERSION:-latest{{"}"}}
     restart: "no"
-    {%- if cookiecutter.orm == 'sqlalchemy' %}
+    {%- if cookiecutter.orm in ['sqlalchemy', 'ormar'] %}
     command: alembic upgrade head
     {%- elif cookiecutter.orm == 'tortoise' %}
     command: aerich upgrade

fastapi_template/template/{{cookiecutter.project_name}}/deploy/kube/app.yml

@@ -28,7 +28,7 @@ spec:
           args:
             - -c
             - >-
-              {%- if cookiecutter.orm == 'sqlalchemy' %}
+              {%- if cookiecutter.orm in ['sqlalchemy', 'ormar'] %}
               alembic upgrade head &&
               {%- elif cookiecutter.orm == 'tortoise' %}
               aerich upgrade &&

fastapi_template/template/{{cookiecutter.project_name}}/deploy/kube/db.yml

@@ -66,7 +66,7 @@ spec:
       - name: migrator
         image: {{cookiecutter.project_name}}:latest
         command:
-          {%- if cookiecutter.orm == 'sqlalchemy' %}
+          {%- if cookiecutter.orm in ['sqlalchemy', 'ormar'] %}
           - "alembic"
           - "upgrade"
           - "head"