Merge tag '3.3.7' into develop

3.3.7

Author: s3rius

.github/workflows/test.yml

@@ -31,7 +31,10 @@ jobs:
         with:
           python-version: '3.9'
       - name: Install deps
-        uses: knowsuchagency/poetry-install@v1
+        run: |
+          pip install -U pip
+          pip install poetry==1.1.13
+          poetry install
         env:
           POETRY_VIRTUALENVS_CREATE: false
       - name: Setup GIT

Dockerfile

@@ -22,7 +22,7 @@ WORKDIR /src
 
 ENV PATH ${PATH}:/home/fastapi_template/.local/bin
 
-RUN pip install poetry==1.1.11
+RUN pip install poetry==1.1.13
 
 COPY . /src/
 RUN pip install .

README.md

@@ -81,7 +81,7 @@ usage: FastAPI template [-h] [--version] [--name PROJECT_NAME]
                         [--ci {none,gitlab_ci,github}] [--redis] [--rabbit]
                         [--migrations] [--kube] [--dummy] [--routers]
                         [--swagger] [--prometheus] [--sentry] [--loguru]
-                        [--opentelemetry] [--force] [--quite]
+                        [--opentelemetry] [--traefik] [--force] [--quite]
 
 optional arguments:
   -h, --help            show this help message and exit
@@ -109,6 +109,7 @@ optional arguments:
   --sentry              Add sentry integration
   --loguru              Add loguru logger
   --opentelemetry       Add opentelemetry integration
+  --traefik             Adds traefik labels to docker container
   --force               Owerrite directory if it exists
   --quite               Do not ask for features during generation
 ```

fastapi_template/cli.py

@@ -158,6 +158,13 @@ def parse_args():
         default=None,
         dest="otlp_enabled",
     )
+    parser.add_argument(
+        "--traefik",
+        help="Adds traefik labels to docker container",
+        action="store_true",
+        default=None,
+        dest="traefik_labels",
+    )
     parser.add_argument(
         "--force",
         help="Owerrite directory if it exists",
@@ -182,7 +189,7 @@ def ask_features(current_context: BuilderContext) -> BuilderContext:
             "name": "enable_redis",
             "value": current_context.enable_redis,
         },
-        "Kubernetes": {
+        "Kubernetes config (deprecated)": {
             "name": "enable_kube",
             "value": current_context.enable_kube,
         },
@@ -214,6 +221,10 @@ def ask_features(current_context: BuilderContext) -> BuilderContext:
             "name": "enable_loguru",
             "value": current_context.enable_loguru,
         },
+        "Traefik labels for docker": {
+            "name": "traefik_labels",
+            "value": current_context.traefik_labels,
+        },
     }
     if current_context.db != DatabaseType.none:
         features["Migrations support"] = {

fastapi_template/input_model.py

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

fastapi_template/template/cookiecutter.json

@@ -35,6 +35,9 @@
     "enable_loguru": {
         "type": "bool"
     },
+    "traefik_labels": {
+        "type": "bool"
+    },
     "add_dummy": {
         "type": "bool"
     },

fastapi_template/template/{{cookiecutter.project_name}}/.flake8

@@ -95,7 +95,17 @@ per-file-ignores =
   WPS410,
 
 exclude =
+  ./.cache,
   ./.git,
+  ./.idea,
+  ./.mypy_cache,
+  ./.pytest_cache,
+  ./.venv,
   ./venv,
-  migrations,
+  ./env,
+  ./cached_venv,
+  ./docs,
+  ./deploy,
   ./var,
+  ./.vscode,
+  *migrations*,

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

@@ -10,7 +10,7 @@ stages:
   except:
     - tags
   before_script:
-    - pip install poetry==1.1.7
+    - pip install poetry==1.1.13
     - poetry config virtualenvs.create false
     - poetry install
 

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

@@ -7,7 +7,7 @@ RUN apt-get update && apt-get install -y \
   && rm -rf /var/lib/apt/lists/*
 {%- endif %}
 
-RUN pip install poetry==1.1.8
+RUN pip install poetry==1.1.13
 
 # Configuring poetry
 RUN poetry config virtualenvs.create false

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

@@ -9,6 +9,18 @@ services:
     restart: always
     env_file:
       - .env
+    {%- if cookiecutter.traefik_labels == "True" %}
+    labels:
+      # Enables traefik for this container.
+      - traefik.enable=true
+      - traefik.http.routers.{{cookiecutter.project_name}}.rule=Host(`{{ "${" }}{{cookiecutter.project_name | upper}}_TRAEFIK_HOST:-{{cookiecutter.project_name}}.localhost{{ "}" }}`)
+      - traefik.http.routers.{{cookiecutter.project_name}}.entrypoints=http
+      - traefik.http.routers.{{cookiecutter.project_name}}.service={{cookiecutter.project_name}}
+      - traefik.http.services.{{cookiecutter.project_name}}.loadbalancer.server.port={{ "${" }}{{cookiecutter.project_name | upper}}_PORT:-8000{{ "}" }}
+    networks:
+      - default
+      - traefik-shared
+    {%- endif %}
     {%- if ((cookiecutter.db_info.name != "none" and cookiecutter.db_info.name != "sqlite") or
             (cookiecutter.enable_redis == "True") or
             (cookiecutter.enable_rmq == "True")) %}
@@ -159,3 +171,10 @@ volumes:
   {{cookiecutter.project_name}}-db-data:
     name: {{cookiecutter.project_name}}-db-data
 {% endif %}
+
+{%- if cookiecutter.traefik_labels == "True" %}
+networks:
+  # Network for traefik.
+  traefik-shared:
+    name: traefik-shared
+{% endif %}