repo-template-service-fastapi

Generalized backend service template using Python and FastAPI.

Status

• Stage: Draft
• Owner:
• License:
• Visibility: Public | Private | Internal
• Reason:
• Promotion criteria to Public:

What This Project Is

• A baseline service skeleton with health checks, structured logging, and OpenAPI output.
• Includes optional worker placeholder for asynchronous processing.

Use This Template

1. Click Use this template on GitHub to create a new repository.
2. Rename package/module identifiers and update ownership metadata.
3. Review .env.example and update environment configuration for your target project.
4. Run validation and CI checks before first release.

Quickstart

Prerequisites

• Python 3.11+
• pip

Install

python -m pip install --upgrade pip
pip install -e ".[dev]"

Run

uvicorn service.main:app --reload --host 0.0.0.0 --port 4000

Checks

ruff check .
pytest -q
mypy src

Documentation

• Overview
• Architecture
• ADRs
• Doctrine Snapshot

Validation

bash tools/validate-template.sh core
bash tools/validate-template.sh advisory

Contributing

See CONTRIBUTING.md.