Local Preview

The repository includes a runnable example application:

src/examples/basic_app.py

Run the example app

uv run uvicorn src.examples.basic_app:app --reload

Open the endpoint

• HTML: http://127.0.0.1:8000/ht
• Liveness: http://127.0.0.1:8000/health/live
• Readiness: http://127.0.0.1:8000/health/ready
• JSON:

curl -H "Accept: application/json" http://127.0.0.1:8000/ht

Run the documentation locally

uv run mkdocs serve

This starts the documentation site with live reload, usually at:

http://127.0.0.1:8000