Skip to content

development.md

Latest commit

 

History

History
49 lines (34 loc) · 700 Bytes

development.md

File metadata and controls

49 lines (34 loc) · 700 Bytes
Raw

Development Guide

Prerequisites

  • Python 3.13 or newer
  • uv
  • Git

Install dependencies

uv sync

Run the application

uv run uvicorn app.main:app --reload

Run tests

uv run pytest

Check code

uv run ruff check .
uv run ruff format --check .
uv run mypy app

Format code

uv run ruff format .

Project conventions

  • Add runtime dependencies with uv add.
  • Add development dependencies with uv add --dev.
  • Commit pyproject.toml and uv.lock.
  • Never commit real environment secrets.
  • Add tests for new behavior.
  • Use Alembic migrations for future database schema changes.