Merge branch 'release/4.0.4'

Author: s3rius

README.md

@@ -35,7 +35,7 @@ python3 -m pip install .
 python3 -m fastapi_template
 ```
 
-Also you can use it with docker.
+Also, you can use it with docker.
 ```bash
 docker run --rm -it -v "$(pwd):/projects" s3rius/fastapi_template
 ```

fastapi_template/cli.py

@@ -8,7 +8,7 @@
     SKIP_ENTRY,
 )
 from importlib.metadata import version
-from typing import Callable, Optional
+from typing import Callable, List, Optional
 from click import Command, Option
 import re
 
@@ -40,20 +40,20 @@ def disable_orm(ctx: BuilderContext) -> MenuEntry:
     return None
 
 
-def do_not_ask_features_if_quite(ctx: BuilderContext) -> Optional[list[MenuEntry]]:
+def do_not_ask_features_if_quite(ctx: BuilderContext) -> Optional[List[MenuEntry]]:
     if ctx.quite:
         return [SKIP_ENTRY]
     return None
 
 
-def check_db(allowed_values: list[str]) -> Callable[[BuilderContext], bool]:
+def check_db(allowed_values: List[str]) -> Callable[[BuilderContext], bool]:
     def checker(ctx: BuilderContext) -> bool:
         return ctx.db not in allowed_values
 
     return checker
 
 
-def check_orm(allowed_values: list[str]) -> Callable[[BuilderContext], bool]:
+def check_orm(allowed_values: List[str]) -> Callable[[BuilderContext], bool]:
     def checker(ctx: BuilderContext) -> bool:
         return ctx.orm not in allowed_values
 
@@ -499,7 +499,7 @@ def checker(ctx: BuilderContext) -> bool:
 
 
 def handle_cli(
-    menus: list[BaseMenuModel],
+    menus: List[BaseMenuModel],
     callback: Callable[[BuilderContext], None],
 ):
     def inner_callback(**cli_args: Any):
@@ -532,7 +532,7 @@ def inner_callback(**cli_args: Any):
 
 
 def run_command(callback: Callable[[BuilderContext], None]) -> None:
-    menus: "list[BaseMenuModel]" = [
+    menus: "List[BaseMenuModel]" = [
         api_menu,
         db_menu,
         orm_menu,

fastapi_template/input_model.py

@@ -1,5 +1,5 @@
 import enum
-from typing import Optional, Callable, Any
+from typing import List, Optional, Callable, Any
 
 from pydantic import BaseModel
 import click
@@ -54,7 +54,7 @@ def generated_name(self) -> str:
 
 class BaseMenuModel(BaseModel, abc.ABC):
     title: str
-    entries: list[MenuEntry]
+    entries: List[MenuEntry]
     description: str = ""
 
     def _preview(self, current_value: str):
@@ -65,7 +65,7 @@ def _preview(self, current_value: str):
         return "Unknown value"
 
     @abc.abstractmethod
-    def get_cli_options(self) -> list[click.Option]:
+    def get_cli_options(self) -> List[click.Option]:
         pass
 
     @abc.abstractmethod
@@ -91,7 +91,7 @@ class SingularMenuModel(BaseMenuModel):
     ]
     parser: Optional[Callable[[str], Any]]
 
-    def get_cli_options(self) -> list[click.Option]:
+    def get_cli_options(self) -> List[click.Option]:
         cli_name = self.code
         if self.cli_name is not None:
             cli_name = self.cli_name
@@ -168,9 +168,9 @@ def after_ask(self, context: "BuilderContext") -> "BuilderContext":
 
 
 class MultiselectMenuModel(BaseMenuModel):
-    before_ask: Optional[Callable[["BuilderContext"], Optional[list[MenuEntry]]]]
+    before_ask: Optional[Callable[["BuilderContext"], Optional[List[MenuEntry]]]]
 
-    def get_cli_options(self) -> list[click.Option]:
+    def get_cli_options(self) -> List[click.Option]:
         options = []
         for entry in self.entries:
             options.append(

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

@@ -73,14 +73,14 @@ This application can be configured with environment variables.
 You can create `.env` file in the root directory and place all
 environment variables here. 
 
-All environment variabels should start with "{{cookiecutter.project_name | upper}}_" prefix.
+All environment variables should start with "{{cookiecutter.project_name | upper}}_" prefix.
 
 For example if you see in your "{{cookiecutter.project_name}}/settings.py" a variable named like
 `random_parameter`, you should provide the "{{cookiecutter.project_name | upper}}_RANDOM_PARAMETER" 
 variable to configure the value. This behaviour can be changed by overriding `env_prefix` property
 in `{{cookiecutter.project_name}}.settings.Settings.Config`.
 
-An exmaple of .env file:
+An example of .env file:
 ```bash
 {{cookiecutter.project_name | upper}}_RELOAD="True"
 {{cookiecutter.project_name | upper}}_PORT="8000"
@@ -156,7 +156,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 in ['sqlalchemy', 'ormar'] %}
-# To run all migrations untill the migration with revision_id.
+# To run all migrations until the migration with revision_id.
 alembic upgrade "<revision_id>"
 
 # To perform all pending migrations.
@@ -168,7 +168,7 @@ aerich upgrade
 {%- elif cookiecutter.orm == 'piccolo' %}
 # You have to set a PICCOLO_CONF variable
 export PICCOLO_CONF="{{cookiecutter.project_name}}.piccolo_conf"
-# Now you can easily run migrations usuing 
+# Now you can easily run migrations using 
 piccolo migrations forwards all
 {%- endif %}
 ```

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

@@ -147,7 +147,7 @@
     "Self-hosted swagger": {
         "enabled": "{{cookiecutter.self_hosted_swagger}}",
         "resources": [
-            "{{cookiecutter.project_name}}/web/static",
+            "{{cookiecutter.project_name}}/static/docs",
             "{{cookiecutter.project_name}}/web/api/docs"
         ]
     },
@@ -210,4 +210,4 @@
             "{{cookiecutter.project_name}}/db_tortoise/migrations/models/1_20210928165300_init_dummy_sqlite.sql"
         ]
     }
-}
+}

fastapi_template/template/{{cookiecutter.project_name}}/pyproject.toml

@@ -123,7 +123,7 @@ aiokafka = "^0.8.0"
 [tool.poetry.dev-dependencies]
 pytest = "^7.2.1"
 flake8 = "~4.0.1"
-mypy = "^0.991"
+mypy = "^1.1.1"
 isort = "^5.11.4"
 pre-commit = "^3.0.1"
 wemake-python-styleguide = "^0.17.0"

fastapi_template/template/{{cookiecutter.project_name}}/{{cookiecutter.project_name}}/conftest.py

@@ -354,7 +354,7 @@ async def test_exchange_name() -> str:
 @pytest.fixture
 async def test_routing_key() -> str:
     """
-    Name of routing key to use whild binding test queue.
+    Name of routing key to use while binding test queue.
 
     :return: key string.
     """

fastapi_template/template/{{cookiecutter.project_name}}/{{cookiecutter.project_name}}/db_ormar/migrations/__init__.py

@@ -1 +1 @@
-"""Alembic migraions."""
+"""Alembic migrations."""

fastapi_template/template/{{cookiecutter.project_name}}/{{cookiecutter.project_name}}/db_ormar/utils.py

@@ -6,7 +6,7 @@
 
 {% if cookiecutter.db_info.name == "postgresql" -%}
 def create_database() -> None:
-    """Create a databse."""
+    """Create a database."""
     db_url = make_url(str(settings.db_url.with_path('/postgres')))
     engine = create_engine(db_url, isolation_level="AUTOCOMMIT")
 
@@ -46,7 +46,7 @@ def drop_database() -> None:
 {%- endif %}
 {%- if cookiecutter.db_info.name == "mysql" %}
 def create_database() -> None:
-    """Create a databse."""
+    """Create a database."""
     engine = create_engine(str(settings.db_url.with_path("/mysql")))
 
     with engine.connect() as conn:
@@ -76,7 +76,7 @@ def drop_database() -> None:
 {%- endif %}
 {%- if cookiecutter.db_info.name == "sqlite" %}
 def create_database() -> None:
-    """Create a databse."""
+    """Create a database."""
 
 def drop_database() -> None:
     """Drop current database."""

fastapi_template/template/{{cookiecutter.project_name}}/{{cookiecutter.project_name}}/db_sa/migrations/__init__.py

@@ -1 +1 @@
-"""Alembic migraions."""
+"""Alembic migrations."""