development.md

Development guide

Requirements

• Python 3.11 or newer
• uv

Setup

uv sync

To sync development dependencies run following command:

uv sync --group dev

Run locally

uv run run.py 

Nix

Enter Nix develop

nix develop

Starting in Nix develop

python run.py

Docker

docker build -t seriousdb .
docker run -p 8000:8000 seriousdb

The server is available at http://127.0.0.1:8000 and its interactive API documentation is at /docs.

The readiness endpoint is available at /health.

Formatting

Format Python files with ruff:

uv run ruff format .

To check formatting without changing files:

uv run ruff format --check .

Nix in Nix develop

ruff format .

Linting

Lint python files with ruff:

uv run ruff check .

Nix in Nix develop

ruff check .

To fix linter errors and warning if possible run following command:

uv run ruff check --fix .

Nix in Nix develop

ruff check --fix .