Merge tag '3.3.6' into develop

3.3.6

Author: s3rius

README.md

@@ -2,7 +2,7 @@
 [![](https://img.shields.io/pypi/dm/fastapi_template?style=for-the-badge)](https://pypi.org/project/fastapi-template/)
 <div align="center">
 <img src="https://raw.githubusercontent.com/s3rius/FastAPI-template/master/images/logo.png" width=700>
-<div><i>Flexible and Lightweight general-purpose template for FastAPI.</i></div>
+<div><i>Flexible general-purpose template for FastAPI.</i></div>
 </div>
 
 ## Usage
@@ -11,6 +11,12 @@
 
 Poetry version must be greater or equal than 1.1.8. Otherwise it won't be able to install SQLAlchemy.
 
+<div align="center">
+  <img src="https://user-images.githubusercontent.com/18153319/137182689-ce714440-7576-46a0-8f96-862a8469a28c.gif"/>
+  <p>Templator in action</p>
+</div>
+
+You can install it directly from pypi with pip.
 ```bash
 python3 -m pip install fastapi_template
 python3 -m fastapi_template
@@ -22,7 +28,7 @@ docker-compose -f deploy/docker-compose.yml --project-directory . build
 docker-compose -f deploy/docker-compose.yml --project-directory . up --build
 ```
 
-If you want to install in from sources then try this:
+If you want to install it from sources, try this:
 ```shell
 python3 -m pip install poetry
 python3 -m pip install .
@@ -34,33 +40,33 @@ Also you can use it with docker.
 docker run --rm -it -v "$(pwd):/projects" s3rius/fastapi_template
 ```
 
-<div align="center">
-  <img src="https://user-images.githubusercontent.com/18153319/137182689-ce714440-7576-46a0-8f96-862a8469a28c.gif"/>
-  <p>Templator in action</p>
-</div>
-
-
 ## Features
 
-One of the coolest features is that this project is extremely small and handy.
-You can choose between different databases and even ORMs. 
-Currently SQLAlchemy1.4, TortoiseORM and Ormar are supported.
+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 SQLAlchemy1.4, TortoiseORM, Piccolo and Ormar are supported.
 
-TUI and CLI and excellent code documentation.
+This project can run as TUI or CLI and has excellent code documentation.
 
 Generator features:
 - You can choose between GraphQL and REST api;
 - Different databases support;
 - Different ORMs support;
 - Optional migrations for each ORM except raw drivers;
-- redis support;
-- rabbitmq support;
+- Optional redis support;
+- Optional rabbitmq support;
 - different CI\CD;
-- Kubernetes config generation;
-- Demo routers and models;
-- Pre-commit integrations;
-- Generated tests;
-- Tests for the generator itself.
+- Optional Kubernetes config generation;
+- Optional Demo routers and models (This helps you to see how project is structured);
+- Pre-commit integration;
+- Generated tests with almost 90% coverage;
+- Tests for the generator itself;
+- Optional Prometheus integration;
+- Optional Sentry integration;
+- Optional Loguru logger;
+- Optional Opentelemetry integration.
+
 
 This project can handle arguments passed through command line.
 
@@ -74,7 +80,8 @@ usage: FastAPI template [-h] [--version] [--name PROJECT_NAME]
                         [--orm {ormar,sqlalchemy,tortoise,psycopg,piccolo}]
                         [--ci {none,gitlab_ci,github}] [--redis] [--rabbit]
                         [--migrations] [--kube] [--dummy] [--routers]
-                        [--swagger] [--force] [--quite]
+                        [--swagger] [--prometheus] [--sentry] [--loguru]
+                        [--opentelemetry] [--force] [--quite]
 
 optional arguments:
   -h, --help            show this help message and exit
@@ -98,6 +105,10 @@ optional arguments:
                         Add dummy model
   --routers             Add example routers
   --swagger             Enable self-hosted Swagger
+  --prometheus          Add prometheus integration
+  --sentry              Add sentry integration
+  --loguru              Add loguru logger
+  --opentelemetry       Add opentelemetry integration
   --force               Owerrite directory if it exists
   --quite               Do not ask for features during generation
 ```

fastapi_template/cli.py

@@ -144,6 +144,13 @@ def parse_args():
         default=None,
         dest="sentry_enabled",
     )
+    parser.add_argument(
+        "--loguru",
+        help="Add loguru logger",
+        action="store_true",
+        default=None,
+        dest="enable_loguru",
+    )
     parser.add_argument(
         "--opentelemetry",
         help="Add opentelemetry integration",
@@ -203,6 +210,10 @@ def ask_features(current_context: BuilderContext) -> BuilderContext:
             "name": "otlp_enabled",
             "value": current_context.otlp_enabled,
         },
+        "Loguru logger": {
+            "name": "enable_loguru",
+            "value": current_context.enable_loguru,
+        },
     }
     if current_context.db != DatabaseType.none:
         features["Migrations support"] = {

fastapi_template/input_model.py

@@ -121,6 +121,7 @@ class BuilderContext(BaseModel):
     sentry_enabled: Optional[bool]
     otlp_enabled: Optional[bool]
     enable_rmq: Optional[bool]
+    enable_loguru: Optional[bool]
     force: bool = False
     quite: bool = False
 

fastapi_template/template/cookiecutter.json

@@ -32,6 +32,9 @@
     "enable_routers": {
         "type": "bool"
     },
+    "enable_loguru": {
+        "type": "bool"
+    },
     "add_dummy": {
         "type": "bool"
     },

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

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

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

@@ -43,27 +43,28 @@ But you have to rebuild image every time you modify `poetry.lock` or `pyproject.
 docker-compose -f deploy/docker-compose.yml --project-directory . build
 ```
 
-{%- if cookiecutter.otlp_enabled == "True" %}
-## Opentelemetry 
-
-If you want to start your project with opentelemetry collector 
-you can add `-f ./deploy/docker-compose.otlp.yml` to your docker command.
-
-Like this:
+## Project structure
 
 ```bash
-docker-compose -f deploy/docker-compose.yml -f deploy/docker-compose.otlp.yml --project-directory . up
-```
-
-This command will start opentelemetry collector and jaeger. 
-After sending a requests you can see traces in jaeger's UI
-at http://localhost:16686/.
-
-This docker configuration is not supposed to be used in production. 
-It's only for demo purpose.
-
-You can read more about opentelemetry here: https://opentelemetry.io/
+$ tree "{{cookiecutter.project_name}}"
+{{cookiecutter.project_name}}
+├── conftest.py  # Fixtures for all tests. 
+{%- if cookiecutter.db_info.name != "none" %}
+├── db  # module contains db configurations
+│   ├── dao  # Data Access Objects. Contains different classes to inteact with database.
+│   └── models  # Package contains different models for ORMs.
 {%- endif %}
+├── __main__.py  # Startup script. Starts uvicorn.
+├── services  # Package for different external services such as rabbit or redis etc.
+├── settings.py  # Main configuration settings for project.
+├── static  # Static content.
+├── tests  # Tests for project.
+└── web  # Package contains web server. Handlers, startup config.
+    ├── api  # Package with all handlers.
+    │   └── router.py  # Main router.
+    ├── application.py  # FastAPI application configuration.
+    └── lifetime.py  # Contains actions to perform on startup and shutdown.
+```
 
 ## Configuration
 
@@ -76,7 +77,8 @@ All environment variabels should start with "{{cookiecutter.project_name | upper
 
 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.
+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:
 ```bash
@@ -87,6 +89,28 @@ An exmaple of .env file:
 
 You can read more about BaseSettings class here: https://pydantic-docs.helpmanual.io/usage/settings/
 
+{%- if cookiecutter.otlp_enabled == "True" %}
+## Opentelemetry 
+
+If you want to start your project with opentelemetry collector 
+you can add `-f ./deploy/docker-compose.otlp.yml` to your docker command.
+
+Like this:
+
+```bash
+docker-compose -f deploy/docker-compose.yml -f deploy/docker-compose.otlp.yml --project-directory . up
+```
+
+This command will start opentelemetry collector and jaeger. 
+After sending a requests you can see traces in jaeger's UI
+at http://localhost:16686/.
+
+This docker configuration is not supposed to be used in production. 
+It's only for demo purpose.
+
+You can read more about opentelemetry here: https://opentelemetry.io/
+{%- endif %}
+
 ## Pre-commit
 
 To install pre-commit simply run inside the shell:

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

@@ -87,6 +87,12 @@
             ".github"
         ]
     },
+    "Loguru": {
+        "enabled": "{{cookiecutter.enable_loguru}}",
+        "resources": [
+            "{{cookiecutter.project_name}}/logging.py"
+        ]
+    },
     "Routers": {
         "enabled": "{{cookiecutter.enable_routers}}",
         "resources": [
@@ -192,4 +198,4 @@
             "{{cookiecutter.project_name}}/db_tortoise/migrations/models/1_20210928165300_init_dummy_sqlite.sql"
         ]
     }
-}
+}

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

@@ -3,8 +3,11 @@ version: '3.9'
 services:
   api:
     ports:
+      # Exposes application port.
     - "8000:8000"
     volumes:
+      # Adds current directory as volume.
     - .:/app/src/
     environment:
+      # Enables autoreload.
       {{cookiecutter.project_name | upper}}_RELOAD: "True"

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

@@ -1,11 +1,13 @@
 services:
   api:
     environment:
+      # Adds opentelemetry endpoint.
       {{cookiecutter.project_name | upper}}_OPENTELEMETRY_ENDPOINT: "http://otel-collector:4317"
 
   otel-collector:
     image: otel/opentelemetry-collector-contrib:0.53.0
     volumes:
+      # Adds config for opentelemetry.
       - ./deploy/otel-collector-config.yml:/config.yml
     command: --config config.yml
     ports:

fastapi_template/template/{{cookiecutter.project_name}}/deploy/otel-collector-config.yml

@@ -1,16 +1,20 @@
+# Receives all info with OpenTelemetry protocol.
 receivers:
   otlp:
     protocols:
       grpc:
       http:
 
+# Batch all spans.
 processors:
   batch:
 
 exporters:
+  # Exports spans to log.
   logging:
     logLevel: info
 
+  # Exports spans to jaeger.
   jaeger:
     endpoint: "jaeger:14250"
     tls: