api-project-starter-kit 1.0.0

Interactive Python CLI that generates production-ready backend boilerplates (FastAPI, Flask, Django).

API Project Starter Kit

Interactive Python CLI that generates production-ready backend boilerplates for FastAPI, Flask, and Django.

Templates are written in Jinja2 — extend them without touching generator logic.

Features

• One-question-at-a-time interactive flow (Questionary + Rich)
• Frameworks: FastAPI · Flask · Django
• Databases: PostgreSQL · MySQL · SQLite · MongoDB · None
• ORMs filtered by framework
• Background jobs: Celery · RQ · Dramatiq · APScheduler (+ Redis / RabbitMQ / Kafka)
• Auth: JWT · OAuth · API Key
• REST or GraphQL
• Docker + docker-compose
• Pytest / Unittest samples
• Ruff · Black · Mypy · pre-commit
• GitHub Actions CI
• Structlog / Loguru / stdlib logging
• CRUD module scaffolding (Users, Products, Orders, …)

Install

pip install api-project-starter-kit

From source (editable):

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Usage

api-starter

# Or as a module
python -m api_starter

# Custom output directory
api-starter --output ~/projects

Answer the prompts, confirm the summary, and a complete project is written to disk.

Layout

api_starter/
├── cli.py                 # Typer entry point
├── generator.py           # Façade
├── prompts.py             # Interactive questions
├── config.py              # Dataclasses & enums
├── validators.py          # Input validation
├── template_engine.py     # Jinja2 wrapper
├── template_registry.py   # Config → template map
├── project_builder.py     # Render + write files
├── filesystem.py          # Path helpers
├── utils/
└── templates/
    ├── fastapi/
    ├── flask/
    ├── django/
    └── shared/            # Docker, CI, jobs, modules, quality

Extending templates

1. Add a .j2 file under api_starter/templates/<framework>/ or shared/.
2. Register it in template_registry.py (TemplateMapping).
3. Use context keys from ProjectConfig.to_template_context() (project_name, package_name, has_database, modules_meta, …).

Programmatic use

from api_starter.config import (
    Framework, Database, ORM, BackgroundJobs, Authentication,
    APIType, TestingFramework, LoggingLibrary, ProjectConfig,
)
from api_starter.generator import Generator

config = ProjectConfig(
    project_name="demo-api",
    framework=Framework.FASTAPI,
    database=Database.SQLITE,
    orm=ORM.SQLALCHEMY,
    background_jobs=BackgroundJobs.NO,
    authentication=Authentication.JWT,
    api_type=APIType.REST,
    docker=True,
    testing=TestingFramework.PYTEST,
    logging=LoggingLibrary.STRUCTLOG,
    github_actions=True,
    output_dir=".",
)

Generator().generate(config)

Publishing to PyPI

pip install -e ".[dev]"
python -m build
twine check dist/*
# TestPyPI first (recommended)
twine upload --repository testpypi dist/*
# Then production PyPI
twine upload dist/*

Create an API token at https://pypi.org/manage/account/token/ and use:

• Username: __token__
• Password: pypi-... (your token)