boilerplate

• python3.14
• textual (tui)
• sqlalchemy / alembic
• uv
• mypy
• ruff
• pre-commit (run ruff and mypy)
• minimal github action for linting / test

reminders

after cloning, run:
$ uv sync
$ uv run pre-commit install

Install & run

uv sync
uv run alembic upgrade head
uv run python main.py

---

Setup

Database (PostgreSQL)

CREATE DATABASE example_db;
CREATE USER example_user WITH ENCRYPTED PASSWORD 'password';
GRANT ALL PRIVILEGES ON DATABASE example_db TO example_user;
ALTER DATABASE example_db OWNER TO example_user;

Copy .env.example to .env and fill in your database credentials.

Dev commands

Run with Textual dev console (for debugging)

textual console [-v|-x]
textual run main.py --dev

Linting & type checking

uv run pre-commit run --all-files
uv run mypy .

Tests with coverage

uv run pytest