chore: sync with fastapi-template

https://github.com/one-zero-eight/fastapi-template

Author: ArtemSBulgakov

.dockerignore

@@ -3,14 +3,10 @@
 
 # Except code
 !/src/
-!/deploy/
+!/pyproject.toml
+!/uv.lock
 !/alembic/
 !/alembic.ini
-!/pyproject.toml
-!logging.yaml
-!uv.lock
 
 # And ignore cache files in the code
 __pycache__
-
-.venv

.github/dependabot.yaml

@@ -6,8 +6,7 @@ updates:
     schedule:
       interval: "weekly"
     groups:
-      # TODO: switch to uv
-      poetry: # currently can't switch to uv because of https://github.com/dependabot/dependabot-core/issues/10478
+      python-dependencies:
         patterns:
           - "*"
 
@@ -16,9 +15,17 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      docker-dependencies:
+        patterns:
+          - "*"
 
   # Enable version updates for Actions
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      actions-dependencies:
+        patterns:
+          - "*"

.github/workflows/build-docker.yaml .github/workflows/deploy.yaml.github/workflows/build-docker.yaml renamed to .github/workflows/deploy.yaml

@@ -1,4 +1,4 @@
-name: Build and publish a Docker image
+name: Build and deploy
 
 on:
   # Allow manual trigger of the workflow
@@ -16,7 +16,7 @@ on:
 env:
   # Use GitHub Container Registry
   REGISTRY: ghcr.io
-  IMAGE_NAME: one-zero-eight/printers
+  IMAGE_NAME: ${{ github.repository }}
 
 jobs:
   build-and-push-image:
@@ -30,26 +30,26 @@ jobs:
     outputs:
       imageid: ${{ steps.build.outputs.imageid }}
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+      - name: 👾 Checkout repository
+        uses: actions/checkout@v5
 
-      - name: Set up Docker Buildx
+      - name: 🐳 Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-      - name: Log in to the Container registry
+      - name: 🐳 Log in to the Container registry
         uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Extract metadata for Docker
+      - name: 🐳 Extract metadata for Docker
         id: meta
         uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
-      - name: Build and push Docker image
+      - name: 🐳 Build and push Docker image
         id: build
         uses: docker/build-push-action@v6
         with:
@@ -63,7 +63,7 @@ jobs:
   deploy:
     # Only on manual trigger or push to main
     if: github.repository_owner == 'one-zero-eight' && (github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && github.ref == 'refs/heads/main'))
-    name: Deploy to server for ${{ github.event.inputs.environment || 'staging' }}
+    name: ⚡️ Deploy to server for ${{ github.event.inputs.environment || 'staging' }}
     needs: build-and-push-image
     runs-on: [self-hosted, innohassle]
     environment:
@@ -75,7 +75,7 @@ jobs:
       group: ${{ github.event.inputs.environment || 'staging' }}
       cancel-in-progress: false
     steps:
-      - name: Deploy via SSH
+      - name: ⚡️ Deploy via SSH
         uses: appleboy/ssh-action@v1.1.0
         with:
           host: ${{ secrets.SSH_HOST }}

.github/workflows/pre-commit.yaml

@@ -1,44 +1,21 @@
-name: pre-commit
+name: Run pre-commit
 
-on: [push, pull_request]
+on: [ push, pull_request ]
 
 jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-      #----------------------------------------------
-      #       Check-out repo and set-up python
-      #----------------------------------------------
-      - name: Check out repository
-        uses: actions/checkout@v4
-
-      #----------------------------------------------
-      #       Install uv
-      #----------------------------------------------
-      # based on https://docs.astral.sh/uv/guides/integration/github/
-      - name: Install uv
-        uses: astral-sh/setup-uv@v5
+      - name: 👾 Check out repository
+        uses: actions/checkout@v5
+      - name: 📦 Set up uv
+        uses: astral-sh/setup-uv@v7
         with:
           enable-cache: true
-
-      - name: "Set up Python"
-        uses: actions/setup-python@v5
-        with:
-          python-version-file: "pyproject.toml"
-      #----------------------------------------------
-      #  Install project dependencies if not cached
-      #----------------------------------------------
-
-      - name: Load pre-commit caches
-        uses: actions/cache@v4
-        with:
-          path: ~/.cache/pre-commit
-          key: pre-commit-3|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
-
-      - name: Install libcups2-dev
-        run: sudo apt-get update && sudo apt-get install libcups2-dev
-
-      - name: Run pre-commit
-        run: uvx pre-commit run --show-diff-on-failure --color=always --all-files --hook-stage manual
+          activate-environment: true
+      - name: 📦 Install the project
+        run: uv sync
+      - name: 🧪 Run pre-commit
+        run: uv run pre-commit run --show-diff-on-failure --color=always --all-files --hook-stage manual
         env:
           RUFF_FORMAT: github

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ default_stages:
 repos:
   # Fix some errors with Ruff
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.4
+    rev: v0.14.0
     hooks:
       - id: ruff
         args: [ --fix, --exit-zero ]
@@ -23,19 +23,17 @@ repos:
 
   # Lint Python files with Ruff
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.4
+    rev: v0.14.0
     hooks:
       - id: ruff
         name: "ruff: linting"
 
   # Check other files
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
-        exclude: typings/
       - id: end-of-file-fixer
-        exclude: typings/
       - id: check-added-large-files
 
   # Local linting
@@ -47,9 +45,3 @@ repos:
         entry: uv run ./scripts/generate_settings_schema.py
         pass_filenames: false
         files: ^src/config_schema.py$
-      - id: uv-check
-        name: uv lockfile check
-        entry: uv lock --check
-        language: system
-        pass_filenames: false
-        files: "pyproject.toml"

Dockerfile

@@ -1,37 +1,51 @@
-# Based on https://github.com/astral-sh/uv-docker-example/blob/main/multistage.Dockerfile
+###########################################################
+# Builder stage. Build dependencies.
 FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim AS builder
-ENV UV_COMPILE_BYTECODE=1 UV_LINK_MODE=copy UV_PYTHON_DOWNLOADS=0
+ENV PYTHONUNBUFFERED=1 \
+    PYTHONDONTWRITEBYTECODE=1 \
+    UV_COMPILE_BYTECODE=1 \
+    UV_LINK_MODE=copy \
+    UV_PYTHON_DOWNLOADS=0
 
 # pycups is sources-only so we have to build it
 RUN apt-get update && apt-get install -y --no-install-recommends libcups2-dev gcc && rm -rf /var/lib/apt/lists/*
 
 WORKDIR /app
+COPY ./pyproject.toml ./uv.lock ./
+
 RUN --mount=type=cache,target=/root/.cache/uv \
-    --mount=type=bind,source=uv.lock,target=uv.lock \
-    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
     uv sync --frozen --no-install-project --no-dev
 
-COPY . /app
-RUN --mount=type=cache,target=/root/.cache/uv \
-    uv sync --frozen --no-dev
 
+###########################################################
+# Production stage. Copy only runtime deps that were installed in the Builder stage.
+FROM python:3.12-slim-bookworm AS production
 
-# Then, use a final image without uv
-FROM python:3.12-slim-bookworm
-# It is important to use the image that matches the builder, as the path to the
-# Python executable must be the same, e.g., using `python:3.11-slim-bookworm`
-# will fail.
-RUN groupadd -g 1500 app && \
-    useradd -m -u 1500 -g app app
+ENV PYTHONUNBUFFERED=1
 
-RUN apt-get update && apt-get install -y --no-install-recommends \
-    libcups2 cups-client && rm -rf /var/lib/apt/lists/*
+RUN apt-get update && apt-get install -y --no-install-recommends libcups2 cups-client && rm -rf /var/lib/apt/lists/*
 
-ENV PATH="/app/.venv/bin:$PATH"
-# Copy the application from the builder
-COPY --from=builder --chown=app:app /app /app
-USER app
+# Copy the applicant from the builder
+COPY --from=builder /app /app
+
+# Create user with the name uv
+RUN groupadd -g 1500 uv && \
+    useradd -m -u 1500 -g uv uv
+
+USER uv
 WORKDIR /app
 
+# Place executables in the environment at the front of the path
+ENV PATH="/app/.venv/bin:$PATH"
+
+COPY --chown=uv:uv . /app
+
 EXPOSE 8000
-CMD [ "gunicorn", "--worker-class", "uvicorn.workers.UvicornWorker", "--bind", "0.0.0.0:8000", "--workers", "1", "src.api.app:app" ]
+CMD ["gunicorn", \
+    "--worker-class", "uvicorn.workers.UvicornWorker", \
+    "--bind", "0.0.0.0:8000", \
+    "--workers", "1", \
+    "src.api.app:app", \
+    "--timeout", "300", \
+    "--forwarded-allow-ips=*" \
+]

README.md

@@ -22,8 +22,7 @@ This is the FastAPI ASGI application.
 
 ### Set up for development
 
-1. Install [Python 3.12+](https://www.python.org/downloads/), [uv](https://docs.astral.sh/uv/),
-   [Docker](https://docs.docker.com/engine/install/)
+1. Install [uv](https://docs.astral.sh/uv/), [Docker](https://docs.docker.com/engine/install/)
 2. Install project dependencies
    ```bash
    uv sync
@@ -33,7 +32,7 @@ This is the FastAPI ASGI application.
    uv run -m src.api --reload
    ```
    > Follow provided instructions if needed
-4. Open in the browser: http://localhost:8000
+4. Open in the browser: http://localhost:8011
    > The api will be reloaded when you edit the code
 
 > [!IMPORTANT]

deploy/docker-entrypoint.sh

@@ -1,40 +1,46 @@
+# This is a Docker Compose configuration for local use.
+
+# Run all services:
+# docker compose up --build --wait
+
 services:
   api:
     build: .
-    volumes:
-      - "./settings.yaml:/app/settings.yaml:ro" # Read-only settings file
+    restart: no
     depends_on:
       db:
         condition: service_healthy
-    restart: always
     ports:
-      - "8000:8000"
+      - "8011:8000"
+    volumes:
+      - "./settings.yaml:/app/settings.yaml:ro" # Read-only settings file
 
   db:
-    # See more: https://registry.hub.docker.com/_/mongo
+    # See more: https://hub.docker.com/_/mongo
     image: "mongo:8.0"
-    restart: always
-    volumes:
-      - "mongodb:/data/db"
+    restart: no
     ports:
       - "27017:27017"
+    volumes:
+      - "mongodb:/data/db"
     healthcheck:
-      test: echo 'db.runCommand("ping").ok' | mongosh localhost:27017/db --quiet
-      interval: 5s
+      test: echo 'db.runCommand("ping").ok' | mongosh 127.0.0.1:27017/db --quiet
       timeout: 5s
-      retries: 5
+      start_period: 30s
+      interval: 1m
     environment:
       MONGO_INITDB_ROOT_USERNAME: ${MONGO_INITDB_ROOT_USERNAME:-mongoadmin}
       MONGO_INITDB_ROOT_PASSWORD: ${MONGO_INITDB_ROOT_PASSWORD:-secret}
 
   unoserver:
     image: ghcr.io/unoconv/unoserver-docker
+    restart: no
     ports:
       - "2003:2003"
 
   cups:
     image: olbat/cupsd:2025-05-12
-    restart: always
+    restart: no
     volumes:
       - "cups:/etc/cups"
     profiles: [ cups ]