fastapi-deck

Interactive TUI scaffold generator for FastAPI projects — think create-next-app but for FastAPI. Answer a few questions and get a complete, runnable project with .env, requirements.txt, SQL database wiring, auth, optional services folder, Docker and tests.

Install

python -m pip install -e .

This registers fastapi-deck as a command on your system.

Usage

fastapi-deck

The wizard asks:

• Project name
• Template: beginner (single file) / standard (layered) / production (domain-driven)
• Database (SQL only for now; MongoDB will be added later):
  • PostgreSQL — async SQLAlchemy + Alembic migrations
  • SQLite — async SQLAlchemy (easiest local dev)
  • None — bare REST skeleton
• Optional features, Next.js style:
  • JWT authentication (python-jose + passlib/bcrypt)
  • A services/ business-logic folder
  • Docker (Dockerfile + docker-compose.yml)
  • pytest smoke tests

Then it generates the project under a directory named after your project.

How it's built (modular architecture)

Everything is pluggable so new templates, databases and features drop in easily:

src/fastapi_deck/
├── cli.py              # interactive wizard (questions)
├── config.py           # ProjectConfig dataclass
├── builder.py          # merges core + layout + provider + features, writes files
├── prompts.py          # rich prompt helpers
├── layouts/            # beginner.py / standard.py / production.py / common.py
├── providers/          # base.py + postgres.py / sqlite.py / nonedb.py
│                       #   -> add MongoDB later by subclassing DBProvider
└── features/           # services.py / docker.py / tests.py (+ registry)

• Layouts decide folder structure and wiring.
• Providers own everything database-specific (requirements, .env, models, routers, migrations). Add providers/mongodb.py + one registry entry later.
• Features are optional, gated additions (Docker, tests, services folder).

Development

python -m pip install -e .
fastapi-deck

Build a distributable package

python -m pip install build
python -m build

The wheel/sdist land in dist/.