overhaul current project to prepare for any updates

switch to `uv`
switch to pyproject.toml for project metadata
make project non-flat
modernize with ruff rules
modernize with strict pylance
format
cleanup around database needs
cleanup around containerization
use dynamic file paths where possible

Author: AbstractUmbra

.dockerignore

@@ -1,9 +1,18 @@
+# generated or tooling
 .git/
 .github/
-types_/
+.ruff_cache/
+.venv/
+
+# types arent needed at runtime
+src/types_/
+
+# meta and template files
+.env
+.env.template
 config.template.toml
+docker-compose.yaml
 Dockerfile
 LICENSE
 migration.sql
-pyproject.toml
 README.md

.gitignore

@@ -161,4 +161,5 @@ cython_debug/
 
 # Config Files...
 config.toml
-.config.toml
+.config.toml
+compose.override.yaml

.python-version

@@ -0,0 +1 @@
+3.13

Dockerfile

@@ -1,26 +1,38 @@
-FROM python:3.12-slim
+ARG PYTHON_BASE=3.13-slim-bookworm
+ARG UV_BASE=python3.13-bookworm-slim
 
-LABEL org.opencontainers.image.source=https://github.com/pythonistaguild/mystbin
-LABEL org.opencontainers.image.description="Container for running MystB.in"
-LABEL org.opencontainers.image.licenses=GPLv3
-
-RUN mkdir -p /etc/apt/keyrings \
-    && apt update -y \
-    && apt-get install --no-install-recommends -y \
-    # deps for building python deps
-    git \
-    build-essential \
-    libcurl4-gnutls-dev \
-    gnutls-dev \
-    libmagic-dev \
+FROM ghcr.io/astral-sh/uv:${UV_BASE} AS builder
+
+ENV UV_PYTHON_DOWNLOADS=0
+
+WORKDIR /project
+
+# install latest git
+RUN apt-get update -y \
+    && apt-get upgrade -y \
+    && apt-get install --no-install-recommends --no-install-suggests -y git \
     && rm -rf /var/lib/apt/lists/*
 
-# copy project requirement files here to ensure they will be cached.
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=pyproject.toml,target=/project/pyproject.toml \
+    --mount=type=bind,source=uv.lock,target=/project/uv.lock \
+    uv sync --frozen --no-install-project --no-dev
+
+ADD --chown=1000:1000 . /project
+
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --frozen --no-install-project --no-dev
+
+FROM python:${PYTHON_BASE}
+
+LABEL org.opencontainers.image.source=https://github.com/pythonistaguild/mystbin
+LABEL org.opencontainers.image.description="A paste service built for simplicity and beauty"
+
+USER 1000:1000
+
 WORKDIR /app
-COPY requirements.txt ./
 
-# install runtime deps
-RUN pip install -Ur requirements.txt
+COPY --from=builder --chown=1000:1000 /project /app
+ENV PATH="/app/.venv/bin:$PATH"
 
-COPY . /app/
-ENTRYPOINT python -O launcher.py
+CMD ["python", "-O", "launcher.py"]

README.md

@@ -36,3 +36,5 @@ Easily share code and text.
 - Run `docker compose up -d` to start the services.
   - If you want to use redis for session/limit handling, run with the redis profile: `docker compose --profile redis up -d`
   - The redis container doesn't expose connections outside of the network, but for added security edit `redis.conf` and change the password.
+
+  - Backing up the database to the host file system is **opt in**. You can use the `backup` profile with docker-compose to spin up the sidecar container for performing backups.

db-backup/.gitignore

@@ -0,0 +1 @@
+backups/

db-backup/backup.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+while true; do
+    DATE=$(date +%F_%H-%M-%S);
+    BACKUP_FILE=/backups/backups/db_backup_${DATE}.sql.zstd;
+    echo "[INFO] Starting backup at ${DATE}";
+    pg_dump -h database -U "${POSTGRES_USER}" -w -d "${POSTGRES_DB}" -Z zstd -f "${BACKUP_FILE}";
+    echo "[INFO] Backup complete: ${BACKUP_FILE}";
+
+    # Keep only last 7 backups
+    find /backups -type f -name 'db_backup_*.sql.zstd' -mtime +7 -delete;
+    echo "[INFO] Cleanup complete. Sleeping for 24h...";
+    sleep 86400;
+done

db-backup/backups/.keep

@@ -2,15 +2,17 @@ services:
   mystbin:
     image: ghcr.io/pythonistaguild/mystbin
     container_name: mystbin
+    environment:
+      - CONFIG_PATH=/app-config
     ports:
       - 8181:8181
     restart: unless-stopped
     depends_on:
       database:
         condition: service_healthy
         restart: true
-    volumes:
-      - ./config.toml:/app/config.toml:ro
+    configs:
+      - app-config
 
   database:
     image: postgres:16
@@ -24,9 +26,30 @@ services:
     env_file: .env
     environment:
       - PG_DATA=/var/lib/postgresql/data
-      - POSTGRES_DB=mystbin
     volumes:
       - mystbin_pg_data:/var/lib/postgresql/data
+    user: "1000:1000"
+
+  db-backups:
+    image: postgres:16
+    container_name: db-backups
+    depends_on:
+      database:
+        condition: service_healthy
+        restart: true
+    env_file:
+      - .env
+    environment:
+      - PGPASSWORD=${POSTGRES_PASSWORD}
+    volumes:
+      - ./db-backup:/backups
+      - ./db-backup/backup.sh:/backup.sh
+    entrypoint: ["/bin/bash"]
+    command: "/backup.sh"
+    restart: unless-stopped
+    user: "1000:1000"
+    profiles:
+      - backup
 
   redis:
     image: redis:latest
@@ -38,5 +61,9 @@ services:
       - "./redis.conf:/config/redis.conf:ro"
     command: ["redis-server", "/config/redis.conf"]
 
+configs:
+  app-config:
+    file: ./config.toml
+
 volumes:
   mystbin_pg_data:

docker-compose.yaml

@@ -23,18 +23,21 @@
 import starlette_plus
 import uvicorn
 
-import core
-import core.config
-
+from src import core
 
 starlette_plus.setup_logging(level=logging.INFO)
-logger: logging.Logger = logging.getLogger(__name__)
+LOGGER = logging.getLogger(__name__)
+
+__all__ = ()
 
 
 async def main() -> None:
-    async with aiohttp.ClientSession() as session, core.Database(
-        dsn=core.CONFIG["DATABASE"]["dsn"], session=session, github_config=core.CONFIG.get("GITHUB")
-    ) as database:
+    async with (
+        aiohttp.ClientSession() as session,
+        core.Database(
+            dsn=core.CONFIG["DATABASE"]["dsn"], session=session, github_config=core.CONFIG.get("GITHUB")
+        ) as database,
+    ):
         app: core.Application = core.Application(database=database)
 
         host: str = core.CONFIG["SERVER"]["host"]
@@ -55,4 +58,4 @@ async def main() -> None:
 try:
     asyncio.run(main())
 except KeyboardInterrupt:
-    logger.info("Closing the MystBin application due to KeyboardInterrupt.")
+    LOGGER.info("Closing the MystBin application due to KeyboardInterrupt.")