Add early boilerplate layout with base modules, config structure, logging setup,

linting/formatting config and minimal app entrypoint. This is an alpha-stage
concept and not yet feature-complete.

Author: Hartmannlight

.github/workflows/build.yml

@@ -0,0 +1,80 @@
+name: build
+
+on:
+  push:
+    branches: ['main']
+  release:
+    types: [published]
+
+env:
+  IMAGE_NAME: ghcr.io/${{ github.repository }}
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v3
+        with:
+          poetry-version: '1.8.4'
+
+      - name: Install dependencies
+        run: poetry install
+
+      - name: Quick tests
+        run: |
+          poetry run pytest
+
+      - name: Log in to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.IMAGE_NAME }}
+          tags: |
+            type=raw,value=latest
+            type=sha
+            type=ref,event=tag
+
+      - name: Set up buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            APP_VERSION=${{ github.ref_name }}
+            APP_COMMIT=${{ github.sha }}
+          cache-from: type=registry,ref=${{ env.IMAGE_NAME }}:buildcache
+          cache-to: type=registry,ref=${{ env.IMAGE_NAME }}:buildcache,mode=max
+
+      - name: Smoke test container
+        run: |
+          docker run -d --name app-test -p 8080:8080 -p 8000:8000 ${{ env.IMAGE_NAME }}:latest
+          sleep 5
+          curl -f http://127.0.0.1:8080/healthz
+          curl -f http://127.0.0.1:8080/readyz
+          curl -f http://127.0.0.1:8000/metrics | head -n 20
+          docker rm -f app-test

.github/workflows/lint.yml

@@ -0,0 +1,38 @@
+name: lint
+
+on:
+  push:
+    branches: ['**']
+  pull_request:
+
+jobs:
+  lint-and-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'  # TODO: keep in sync with pyproject.toml
+
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v3
+        with:
+          poetry-version: '1.8.4'
+
+      - name: Install dependencies
+        run: poetry install
+
+      - name: Check pyproject
+        run: poetry check
+
+      - name: Run pre-commit
+        run: poetry run pre-commit run --all-files
+
+      - name: Run mypy
+        run: poetry run mypy src
+
+      - name: Run tests
+        run: poetry run pytest

.gitignore

@@ -0,0 +1,37 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+*.so
+*.egg-info/
+dist/
+build/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Poetry
+poetry.lock
+
+# PyCharm / VSCode / IDEs
+.idea/
+.vscode/
+
+# Testing
+.pytest_cache/
+
+# Environments
+.env
+.env.*
+
+# Mypy
+.mypy_cache/
+
+# Ruff
+.ruff_cache/
+
+# Docker
+*.log

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+fail_fast: true
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-toml
+      - id: check-json
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.7.1
+    hooks:
+      - id: ruff
+      - id: ruff-format
+
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: poetry run mypy src
+        language: system
+        pass_filenames: false

Dockerfile

@@ -0,0 +1,22 @@
+# TODO: update maintainer and possibly python version
+FROM python:3.11-slim
+
+ENV PYTHONUNBUFFERED=1
+WORKDIR /app
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends build-essential && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY pyproject.toml poetry.lock* /app/
+
+RUN pip install --no-cache-dir poetry && \
+    poetry install --no-root
+
+COPY src /app/src
+ENV PYTHONPATH=/app/src
+
+EXPOSE 8000
+
+# TODO: rename when changing entrypoint
+CMD ["poetry", "run", "app"]