chore: add template

Author: emptybutton

.dockerignore

@@ -0,0 +1,5 @@
+.git
+.venv
+.mypy_cache
+.pytest_cache
+.ruff_cache

.env.template

@@ -0,0 +1,2 @@
+POSTGRES_URL=  # str
+JWT_SECRET=  # str

.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: ruff
+        run: docker compose -f deployments/dev/docker-compose.yaml run backend ruff check src tests
+
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: mypy
+        run: docker compose -f deployments/dev/docker-compose.yaml run backend mypy src tests
+
+  pytest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: pytest
+        run: docker compose -f deployments/dev/docker-compose.yaml run backend pytest tests --cov --cov-report=xml
+
+      - name: upload coverage reports to codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -169,3 +169,7 @@ cython_debug/
 
 # PyPI configuration file
 .pypirc
+
+# Custom
+.ruff_cache
+.uv_cache

README.md

@@ -1,2 +1,2 @@
-# temp
-temp
+# APPNANE_SNAKE_CASE
+kebab-case > snake_case

alembic.ini

@@ -0,0 +1,119 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = src/appname_snake_case/infrastructure/alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = sys
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library and tzdata library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to src/app/infrastructure/alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:src/app/infrastructure/alembic/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+# version_path_separator = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+version_path_separator = os
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = none
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

deployments/dev/.env.template

@@ -0,0 +1 @@
+# External environment variables are not required.

deployments/dev/backend/Dockerfile

@@ -0,0 +1,15 @@
+FROM ghcr.io/astral-sh/uv:python3.13-alpine AS app
+
+WORKDIR /app
+COPY . .
+
+ENV UV_LINK_MODE copy
+ENV UV_PROJECT_ENVIRONMENT /run/app/.venv
+RUN uv sync --extra dev
+
+ENV PYTHONPATH /app/src:/app/tests
+ENV MYPYPATH /app/src:/app/tests
+
+ENV WATCHFILES_FORCE_POLLING true
+
+ENTRYPOINT ["ash", "deployments/dev/backend/entrypoint.sh"]

deployments/dev/backend/entrypoint.sh

@@ -0,0 +1,5 @@
+#!/bin/ash
+
+source ${UV_PROJECT_ENVIRONMENT}/bin/activate
+alembic upgrade head
+$@

deployments/dev/docker-compose.yaml

@@ -0,0 +1,51 @@
+name: appname_kebab_case
+
+services:
+  backend:
+    build:
+      context: ../../
+      dockerfile: deployments/dev/backend/Dockerfile
+      tags:
+        - "appname_kebab_case-backend:dev"
+    container_name: appname_kebab_case-backend
+    volumes:
+      - ../..:/app
+      - backend-data:/run/app
+    ports:
+      - 8000:8000
+    depends_on:
+      postgres:
+        condition: service_healthy
+    environment:
+      JWT_SECRET: super-secret-jwt-secret
+      POSTGRES_URL: postgresql+psycopg://root:root@postgres/root
+    command: appname_kebab_case-web-service
+    healthcheck:
+      test: wget backend:8000/healthcheck -q -O /dev/null
+      start_period: 1m
+      start_interval: 1s
+      interval: 5s
+
+  postgres:
+    image: postgres:16.3-alpine3.19
+    container_name: appname_kebab_case-postgres
+    labels:
+      deployment: dev
+    volumes:
+      - postgres-data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_DB: root
+      POSTGRES_USER: root
+      POSTGRES_PASSWORD: root
+    healthcheck:
+      test: pg_isready -d root -U root
+      start_period: 1m
+      start_interval: 1s
+      interval: 5s
+
+volumes:
+  backend-data: null
+
+  postgres-data:
+    labels:
+      db: true