Merge branch 'release/5.1.1'

Author: s3rius

.github/workflows/test.yml

@@ -23,21 +23,21 @@ jobs:
     if: ${{ needs.pre_job.outputs.should_skip != 'true' }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: '3.9'
+          python-version: '3.11'
       - name: Install deps
         run: |
           pip install -U pip
-          pip install poetry==1.4.2
+          pip install poetry==1.8.2
           poetry install
         env:
-          POETRY_VIRTUALENVS_CREATE: false
+          POETRY_VIRTUALENVS_CREATE: "False"
       - name: Setup GIT
         run: |
           git config --global user.name "fastapi_template"
           git config --global user.email "fastapi_template@pytest.python"
       - name: Run tests
-        run: poetry run pytest -vv
+        run: pytest -vv

README.md

@@ -45,7 +45,7 @@ docker run --rm -it -v "$(pwd):/projects" s3rius/fastapi_template
 One of the coolest features is that this project is extremely configurable.
 You can choose between different databases and even ORMs, or
 you can even generate a project without a database!
-Currently SQLAlchemy 2.0, TortoiseORM, Piccolo and Ormar are supported.
+Currently SQLAlchemy 2.0, TortoiseORM, Piccolo, Ormar and Beanie are supported.
 
 This project can run as TUI or CLI and has excellent code documentation.
 
@@ -82,11 +82,11 @@ Options:
   -n, --name TEXT                 Name of your awesome project
   -V, --version                   Prints current version
   --force                         Owerrite directory if it exists
-  --quite                         Do not ask for features during generation
+  --quiet                         Do not ask for features during generation
   --api-type [rest|graphql]       Select API type for your application
-  --db [none|sqlite|mysql|postgresql]
+  --db [none|sqlite|mysql|postgresql|mongodb]
                                   Select a database for your app
-  --orm [none|ormar|sqlalchemy|tortoise|psycopg|piccolo]
+  --orm [none|ormar|sqlalchemy|tortoise|psycopg|piccolo|beanie]
                                   Choose Object–Relational Mapper lib
   --ci [none|gitlab_ci|github]    Select a CI for your app
   --redis                         Add redis support

fastapi_template/cli.py

@@ -41,8 +41,8 @@ def disable_orm(ctx: BuilderContext) -> Optional[MenuEntry]:
     return None
 
 
-def do_not_ask_features_if_quite(ctx: BuilderContext) -> Optional[List[MenuEntry]]:
-    if ctx.quite:
+def do_not_ask_features_if_quiet(ctx: BuilderContext) -> Optional[List[MenuEntry]]:
+    if ctx.quiet:
         return [SKIP_ENTRY]
     return None
 
@@ -158,7 +158,7 @@ def checker(ctx: BuilderContext) -> bool:
             ),
             additional_info=Database(
                 name="mysql",
-                image="bitnami/mysql:8.0.30",
+                image="mysql:8.4",
                 async_driver="mysql+aiomysql",
                 driver_short="mysql",
                 driver="mysql",
@@ -178,13 +178,30 @@ def checker(ctx: BuilderContext) -> bool:
             ),
             additional_info=Database(
                 name="postgresql",
-                image="postgres:13.8-bullseye",
+                image="postgres:16.3-bullseye",
                 async_driver="postgresql+asyncpg",
                 driver_short="postgres",
                 driver="postgresql",
                 port=5432,
             ),
         ),
+        MenuEntry(
+            code="mongodb",
+            user_view="MongoDB",
+            description=(
+                "{name} is one of the most popular NoSQL databases out there.".format(
+                    name=colored("MongoDB", color="green"),
+                )
+            ),
+            additional_info=Database(
+                name="mongodb",
+                image="mongo:7.0",
+                async_driver="beanie",
+                driver_short="mongodb",
+                driver="mongodb",
+                port=27017
+            ),
+        )
     ],
 )
 
@@ -243,7 +260,7 @@ def checker(ctx: BuilderContext) -> bool:
     entries=[
         MenuEntry(
             code="none",
-            user_view="Whithout ORMs",
+            user_view="Without ORMs",
             description=(
                 "If you select this option, you will get only {what}.\n"
                 "The rest {warn}.".format(
@@ -256,7 +273,7 @@ def checker(ctx: BuilderContext) -> bool:
         MenuEntry(
             code="ormar",
             user_view="Ormar",
-            pydantic_v1=True,
+            is_hidden=check_db(["sqlite", "mysql", "postgresql"]),
             description=(
                 "{what} is a great {feature} ORM.\n"
                 "It's compatible with pydantic models and alembic migrator.".format(
@@ -268,6 +285,7 @@ def checker(ctx: BuilderContext) -> bool:
         MenuEntry(
             code="sqlalchemy",
             user_view="SQLAlchemy",
+            is_hidden=check_db(["sqlite", "mysql", "postgresql"]),
             description=(
                 "{what} is the most popular python ORM.\n"
                 "It has a {feature} and a big community around it.".format(
@@ -279,6 +297,7 @@ def checker(ctx: BuilderContext) -> bool:
         MenuEntry(
             code="tortoise",
             user_view="Tortoise",
+            is_hidden=check_db(["sqlite", "mysql", "postgresql"]),
             description=(
                 "{what} is a great {feature} ORM.\n"
                 "It's easy to use, it has it's own migration tooling.".format(
@@ -312,6 +331,18 @@ def checker(ctx: BuilderContext) -> bool:
                 )
             ),
         ),
+        MenuEntry(
+            code="beanie",
+            user_view="Beanie",
+            is_hidden=check_db(["mongodb"]),
+            description=(
+                "{what} is an asynchronous object-document mapper (ODM) for MongoDB.\n"
+                "Data models are based on Pydantic.".format(
+                    what=colored("Beanie", color="green"),
+                )
+            ),
+        ),
+
     ],
 )
 
@@ -320,14 +351,8 @@ def checker(ctx: BuilderContext) -> bool:
     code="features",
     description="Additional project features",
     multiselect=True,
-    before_ask=do_not_ask_features_if_quite,
+    before_ask=do_not_ask_features_if_quiet,
     entries=[
-        MenuEntry(
-            code="pydanticv1",
-            cli_name="pydantic-v1",
-            user_view="Use older version of pydantic",
-            description="Use pydantic version ^1 instead of ^2",
-        ),
         MenuEntry(
             code="enable_redis",
             cli_name="redis",
@@ -661,7 +686,7 @@ def run_command(callback: Callable[[BuilderContext], None]) -> None:
                 help="Owerrite directory if it exists",
             ),
             Option(
-                ["--quite"],
+                ["--quiet"],
                 is_flag=True,
                 help="Do not ask for features during generation",
             ),

fastapi_template/input_model.py

@@ -1,5 +1,4 @@
 import abc
-import enum
 from collections import UserDict
 from typing import Any, Callable, List, Optional
 
@@ -29,7 +28,6 @@ class MenuEntry(BaseModel):
     description: str
     is_hidden: Optional[Callable[["BuilderContext"], bool]] = None
     additional_info: Any = None
-    pydantic_v1: bool = False
 
     @property
     def generated_name(self) -> str:
@@ -159,8 +157,6 @@ def ask(self, context: "BuilderContext") -> Optional["BuilderContext"]:
             return
 
         setattr(context, self.code, chosen_entry.code)
-        if chosen_entry.pydantic_v1:
-            context.pydanticv1 = True
 
         return context
 
@@ -240,10 +236,6 @@ def ask(self, context: "BuilderContext") -> Optional["BuilderContext"]:
         for entry in chosen_entries:
             setattr(context, entry.code, True)
 
-        for ch_entry in chosen_entries:
-            if ch_entry.pydantic_v1:
-                context.pydanticv1 = True
-
         return context
 
 

fastapi_template/template/cookiecutter.json

@@ -59,9 +59,6 @@
     "otlp_enabled": {
         "type": "bool"
     },
-    "pydanticv1": {
-        "type": "bool"
-    },
     "gunicorn": {
         "type": "bool"
     },

fastapi_template/template/{{cookiecutter.project_name}}/.github/workflows/tests.yml

@@ -3,48 +3,24 @@ name: Testing {{cookiecutter.project_name}}
 on: push
 
 jobs:
-  black:
+  lint:
+    strategy:
+      matrix:
+        cmd:
+          - black
+          - ruff
+          - mypy
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: '3.9'
-      - name: Install deps
-        uses: knowsuchagency/poetry-install@v1
-        env:
-          POETRY_VIRTUALENVS_CREATE: false
-      - name: Run black check
-        run: poetry run black --check .
-  flake8:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: '3.9'
-      - name: Install deps
-        uses: knowsuchagency/poetry-install@v1
-        env:
-          POETRY_VIRTUALENVS_CREATE: false
-      - name: Run flake8 check
-        run: poetry run flake8 --count .
-  mypy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.11'
       - name: Install deps
-        uses: knowsuchagency/poetry-install@v1
-        env:
-          POETRY_VIRTUALENVS_CREATE: false
-      - name: Run mypy check
-        run: poetry run mypy .
+        run: poetry install
+      - name: Run lint check
+        run: poetry run pre-commit run -a {{ '${{' }} matrix.cmd {{ '}}' }}
   pytest:
     runs-on: ubuntu-latest
     {%- if ((cookiecutter.db_info.name != "none" and cookiecutter.db_info.name != "sqlite") or
@@ -63,13 +39,16 @@ jobs:
           {%- endif %}
           {%- if cookiecutter.db_info.name == "mysql" %}
           MYSQL_ROOT_PASSWORD: "{{ cookiecutter.project_name }}"
-          MYSQL_ROOT_USER: "{{ cookiecutter.project_name }}"
+          MYSQL_USER: "{{ cookiecutter.project_name }}"
           MYSQL_DATABASE: "{{ cookiecutter.project_name }}"
-          MYSQL_AUTHENTICATION_PLUGIN: "mysql_native_password"
           {%- endif %}
-        {%- if cookiecutter.db_info.name == "mysql" %}
+          {%- if cookiecutter.db_info.name == "mongodb" %}
+          MONGO_INITDB_ROOT_USERNAME: "{{ cookiecutter.project_name }}"
+          MONGO_INITDB_ROOT_PASSWORD: "{{ cookiecutter.project_name }}"
+          {%- endif %}
+         {%- if cookiecutter.db_info.name == "mysql" %}
         options: >-
-          --health-cmd="mysqladmin ping -u root"
+          --health-cmd="mysqladmin ping --user={{ cookiecutter.project_name }} --password={{ cookiecutter.project_name }}"
           --health-interval=15s
           --health-timeout=5s
           --health-retries=6
@@ -148,6 +127,9 @@ jobs:
         {%- if cookiecutter.db_info.name != "sqlite" %}
           {{ cookiecutter.project_name | upper }}_DB_HOST: localhost
         {%- endif %}
+        {%- if cookiecutter.db_info.name == "mongodb" %}
+          {{ cookiecutter.project_name | upper }}_DB_BASE: admin
+        {%- endif %}
         {%- endif %}
         {%- if cookiecutter.enable_rmq == "True" %}
           {{ cookiecutter.project_name | upper }}_RABBIT_HOST: localhost

fastapi_template/template/{{cookiecutter.project_name}}/.gitlab-ci.yml

@@ -69,6 +69,16 @@ pytest:
     MYSQL_DATABASE: {{ cookiecutter.project_name }}
     ALLOW_EMPTY_PASSWORD: yes
     {%- endif %}
+
+    {%- if cookiecutter.db_info.name == "mongodb" %}
+
+    # MongoDB variables
+    {{ cookiecutter.project_name | upper }}_DB_HOST: database
+    {{ cookiecutter.project_name | upper }}_DB_BASE: admin
+    MONGO_INITDB_ROOT_USERNAME: {{ cookiecutter.project_name }}
+    MONGO_INITDB_ROOT_PASSWORD: {{ cookiecutter.project_name }}
+    {%- endif %}
+ 
     {%- if cookiecutter.enable_rmq == "True" %}
 
     # Rabbitmq variables

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

@@ -2,56 +2,22 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
-    - repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v2.4.0
-      hooks:
-          - id: check-ast
-          - id: trailing-whitespace
-          - id: check-toml
-          - id: end-of-file-fixer
-
-    - repo: https://github.com/asottile/add-trailing-comma
-      rev: v2.1.0
-      hooks:
-          - id: add-trailing-comma
-
-    - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-      rev: v2.1.0
-      hooks:
-          - id: pretty-format-yaml
-            args:
-              - --autofix
-              - --preserve-quotes
-              - --indent=2
-
     - repo: local
       hooks:
-          - id: autoflake
-            name: autoflake
-            entry: poetry run autoflake
-            language: system
-            types: [python]
-            args: [--in-place, --remove-all-unused-imports, --remove-duplicate-keys]
 
           - id: black
             name: Format with Black
             entry: poetry run black
             language: system
             types: [python]
 
-          - id: isort
-            name: isort
-            entry: poetry run isort
-            language: system
-            types: [python]
-
-          - id: flake8
-            name: Check with Flake8
-            entry: poetry run flake8
+          - id: ruff
+            name: Check with Ruff
+            entry: poetry run ruff
             language: system
             pass_filenames: false
-            types: [python]
-            args: [--count, .]
+            always_run: true
+            args: ["check", "{{cookiecutter.project_name}}", "tests", "--fix"]
 
           - id: mypy
             name: Validate types with MyPy