fastapi-spawn 0.1.0__tar.gz → 0.2.0__tar.gz

{fastapi_spawn-0.1.0 → fastapi_spawn-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-spawn
-Version: 0.1.0
+Version: 0.2.0
 Summary: A powerful CLI tool to scaffold production-ready FastAPI projects with flexible database, auth, broker, and deployment options.
 Project-URL: Homepage, https://github.com/Bishwajitgarai/fastapi-spawn
 Project-URL: Documentation, https://github.com/Bishwajitgarai/fastapi-spawn#readme
@@ -50,31 +50,9 @@ Description-Content-Type: text/markdown
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=flat-square)](LICENSE)
 [![CI](https://img.shields.io/github/actions/workflow/status/Bishwajitgarai/fastapi-spawn/tests.yml?label=tests&style=flat-square)](https://github.com/Bishwajitgarai/fastapi-spawn/actions)
 
-</div>
-
----
+Generate production-ready FastAPI projects in seconds — with exactly the stack you need.
 
-## Why fastapi-spawn?
-
-`fastapi-spawn` generates **production-ready** FastAPI projects in seconds. No boilerplate, no guesswork — just run one command and get a fully structured, configured project with the exact stack you need.
-
-| Feature | scaffold-fastapi | **fastapi-spawn** |
-|---|---|---|
-| Interactive TUI | Basic prompts | ✅ Rich questionary TUI |
-| Databases | PostgreSQL, MongoDB, SQLite | ✅ + MySQL |
-| ORM | None | ✅ SQLAlchemy 2.x, Tortoise, Beanie |
-| Migrations | ❌ | ✅ Alembic (async), Aerich |
-| Auth | ❌ | ✅ JWT, OAuth2, API Key |
-| Message brokers | Redis, RabbitMQ | ✅ + Kafka |
-| File storage | ❌ | ✅ AWS S3 (boto3) |
-| AI integration | ❌ | ✅ OpenAI, Anthropic |
-| Config style | Single URL | ✅ Individual fields + `@property` URL |
-| Entry point | app/main.py | ✅ Root `main.py` (`uv run main.py`) |
-| CI/CD | GitHub Actions | ✅ GitHub Actions + GitLab CI |
-| Observability | ❌ | ✅ /health /readiness /liveness |
-| Logging | None | ✅ loguru / structlog / standard |
-| Package manager | uv | ✅ uv (with `[tool.uv]` config) |
-| Dry-run mode | ❌ | ✅ Preview tree before generating |
+</div>
 
 ---
 
@@ -91,10 +69,10 @@ uv pip install fastapi-spawn
 ## Quick Start
 
 ```bash
-# Fully interactive — guided TUI
+# Interactive TUI — guided step-by-step
 fastapi-spawn new my-api
 
-# One-liner (all flags)
+# One-liner with all flags
 fastapi-spawn new my-api \
   --db postgresql \
   --orm sqlalchemy \
@@ -103,87 +81,73 @@ fastapi-spawn new my-api \
   --broker redis \
   --storage s3 \
   --ai openai \
+  --monitoring sentry \
+  --email sendgrid \
+  --log-dest cloudwatch \
+  --vector-db qdrant \
   --stack full \
-  --ci github \
-  --log-lib loguru
+  --ci github
 
-# Preview without writing files
+# Preview file tree without writing
 fastapi-spawn new my-api --dry-run
+
+# Add a feature to an existing project
+fastapi-spawn add openai
+fastapi-spawn add alembic
+fastapi-spawn add sentry
 ```
 
 ---
 
-## Generated Project Structure
+## What Gets Generated
 
 ```
 my-api/
 ├── app/
 │   ├── api/
 │   │   └── v1/
-│   │       ├── health.py        # /health  /readiness  /liveness
-│   │       └── auth.py          # JWT login + refresh
+│   │       ├── health.py        # GET /health  /readiness  /liveness
+│   │       └── auth.py          # POST /auth/login  /auth/refresh
 │   ├── core/
-│   │   ├── config.py            # Pydantic Settings v2 (individual env fields)
-│   │   ├── logging.py           # loguru / structlog / standard
-│   │   ├── exceptions.py        # Custom exception hierarchy
-│   │   ├── security.py          # JWT + bcrypt (when auth enabled)
-│   │   ├── storage.py           # AWS S3 utils (when s3 chosen)
-│   │   └── ai.py                # OpenAI / Anthropic client (when AI chosen)
+│   │   ├── config.py            # Pydantic Settings v2 — individual env fields + @property URLs
+│   │   ├── logger.py            # Context-var logger — request ID, client IP, dual-timezone
+│   │   ├── exceptions.py        # Custom exception hierarchy + handlers
+│   │   ├── security.py          # JWT / bcrypt
+│   │   ├── storage.py           # AWS S3 / MinIO helpers
+│   │   ├── ai.py                # OpenAI / Anthropic / Gemini / Ollama async client
+│   │   ├── email.py             # SendGrid / SMTP / SES
+│   │   └── monitoring.py        # Sentry init / Prometheus metrics
+│   ├── middleware/
+│   │   ├── request_logger.py    # X-Request-ID, response time, structured logs
+│   │   └── rate_limit.py        # slowapi — 429 with Retry-After
 │   ├── db/
 │   │   └── session.py           # Async SQLAlchemy / Tortoise / Beanie
-│   ├── models/                  # ORM models
-│   ├── schemas/                 # Pydantic schemas
-│   ├── services/                # Business logic layer
-│   └── repositories/            # Data access layer
+│   ├── models/
+│   ├── schemas/
+│   ├── services/
+│   └── repositories/
 ├── tasks/                       # Celery workers (root-level)
 │   ├── celery_app.py
 │   └── sample_tasks.py
-├── migrations/                  # Alembic migrations
-│   ├── env.py                   # Async-compatible env
+├── migrations/                  # Alembic (async-compatible)
+│   ├── env.py
 │   └── versions/
 ├── infra/
 │   ├── docker/
 │   ├── helm/
 │   └── terraform/
 ├── tests/
-│   ├── conftest.py
-│   └── test_health.py
-├── main.py                      # uv run main.py entry point
+├── logs/                        # Local log rotation directory
+├── main.py                      # uv run main.py
 ├── alembic.ini
-├── Dockerfile                   # Uses uv for fast builds
-├── docker-compose.yml           # All services pre-configured
+├── Dockerfile                   # Uses uv for fast layer-cached builds
+├── docker-compose.yml           # All selected services pre-configured
 ├── .env                         # gitignored
 ├── .env.example
 ├── .gitignore
 ├── .pre-commit-config.yaml
 ├── Makefile
-└── pyproject.toml               # uv-compatible
-```
-
----
-
-## Environment Variables
-
-`fastapi-spawn` generates **individual env fields** (not URL strings) for every service, assembled into URLs via `@property`:
-
-```env
-# PostgreSQL — assembled into DATABASE_URL by settings
-POSTGRES_USER=postgres
-POSTGRES_PASSWORD=postgres
-POSTGRES_HOST=localhost
-POSTGRES_PORT=5432
-POSTGRES_DB=my_api_db
-
-# OpenAI — supports custom base URL for Azure / LM Studio
-OPENAI_API_KEY=sk-placeholder
-OPENAI_MODEL=gpt-4o
-OPENAI_BASE_URL=                # blank = api.openai.com
-
-# Redis
-REDIS_HOST=localhost
-REDIS_PORT=6379
-REDIS_PASSWORD=
-REDIS_DB=0
+└── pyproject.toml               # uv-compatible with [tool.uv.scripts]
 ```
 
 ---
@@ -193,42 +157,128 @@ REDIS_DB=0
 ```
 fastapi-spawn new [OPTIONS] PROJECT_NAME
 
+Database & ORM
   --db           postgresql | mysql | mongodb | sqlite | none
   --orm          sqlalchemy | tortoise | beanie | none
   --migration    alembic | aerich | none
+
+Auth & Security
   --auth         jwt | oauth2 | api-key | none
+
+Messaging & Cache
   --broker       redis | rabbitmq | kafka | none
   --cache        redis | memcached | none
-  --storage      s3 | local | none
-  --ai           openai | anthropic | none
+
+Storage
+  --storage      s3 | local | none          (s3 = AWS S3 or MinIO)
+
+AI / LLM
+  --ai           openai | anthropic | gemini | ollama | none
+
+Monitoring
+  --monitoring   sentry | prometheus | both | none
+
+Email
+  --email        sendgrid | smtp | ses | none
+
+Notifications
+  --notify       slack | discord | none
+
+Logging
+  --log-lib      loguru | structlog | standard
+  --log-dest     local | cloudwatch | datadog | none
+
+Vector Database
+  --vector-db    qdrant | pinecone | elasticsearch | none
+
+Deployment
   --stack        minimal | standard | full
   --ci           github | gitlab | both | none
-  --log-lib      loguru | structlog | standard
+
+Flags
   --no-docker    Skip Docker files
   --no-tests     Skip test suite
-  --dry-run      Preview file tree only
+  --dry-run      Preview file tree without writing
   --force / -f   Overwrite existing directory
-  --output / -o  Output directory (default: .)
+  --output / -o  Output directory
 ```
 
-### Subcommands
+---
+
+## uv run Scripts
+
+Every generated project has `[tool.uv.scripts]` pre-wired:
 
 ```bash
-fastapi-spawn list-templates   # Show all options + ORM/DB compatibility
-fastapi-spawn validate FILE    # Validate a .fastapi-spawn.toml
+uv run dev        # uvicorn --reload
+uv run start      # python main.py
+uv run test       # pytest --cov
+uv run lint       # ruff check
+uv run format     # ruff format
+uv run typecheck  # mypy
+uv run migrate    # alembic upgrade head  (if alembic)
+uv run rollback   # alembic downgrade -1  (if alembic)
+uv run makemig    # alembic revision --autogenerate  (if alembic)
+uv run worker     # celery worker  (if broker)
+uv run beat       # celery beat    (if broker)
+```
+
+---
+
+## Environment Variables
+
+Individual fields per service — **no URL strings**. URLs are assembled via `@property`:
+
+```env
+ENVIRONMENT=dev
+SECRET_KEY=super-secret-change-in-production
+
+# PostgreSQL
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
+POSTGRES_DB=my_api_db
+
+# Redis
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_PASSWORD=
+REDIS_DB=0
+
+# AWS S3 (or MinIO — set ENDPOINT_URL for local)
+AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
+AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG
+AWS_REGION=us-east-1
+AWS_S3_BUCKET=my-api-bucket
+AWS_S3_ENDPOINT_URL=http://localhost:9000   # MinIO local
+
+# OpenAI (supports custom base URL for Azure / LM Studio)
+OPENAI_API_KEY=sk-placeholder
+OPENAI_MODEL=gpt-4o
+OPENAI_BASE_URL=
+
+# Sentry
+SENTRY_DSN=https://xxx@sentry.io/yyy
+
+# Logging
+LOG_LEVEL=INFO
+LOG_DIR=logs
+LOG_BACKUP_DAYS=30
 ```
 
 ---
 
-## After Scaffolding
+## Add Features to Existing Projects
 
 ```bash
-cd my-api
-uv sync                        # Install all dependencies
-uv run alembic upgrade head    # Run DB migrations (if alembic)
-docker compose up --build      # Start all services
-# or
-uv run main.py                 # Run locally
+fastapi-spawn add sentry      # Sentry error tracking setup
+fastapi-spawn add openai      # OpenAI async client + env vars
+fastapi-spawn add alembic     # Alembic async migrations
+fastapi-spawn add s3          # AWS S3 / MinIO storage utils
+fastapi-spawn add celery      # Celery worker + tasks/
+fastapi-spawn add helm        # Helm chart in infra/helm/
+fastapi-spawn add terraform   # Terraform scaffold in infra/terraform/
 ```
 
 ---
@@ -244,6 +294,18 @@ uv run main.py                 # Run locally
 
 ---
 
+## Middleware Stack (always included)
+
+| Middleware | What it does |
+|---|---|
+| `RequestLoggingMiddleware` | Logs `→ METHOD /path` + `✓ status duration` with request ID |
+| `RateLimitMiddleware` | 200 req/min default via slowapi, returns 429 + `Retry-After` |
+| `CORSMiddleware` | Configurable via `CORS_ORIGINS` env var |
+
+Every response includes `X-Request-ID` and `X-Response-Time` headers.
+
+---
+
 ## Contributing
 
 ```bash
@@ -253,8 +315,6 @@ uv sync --all-extras
 uv run pytest
 ```
 
-PRs are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md).
-
 ---
 
 ## License

fastapi_spawn-0.2.0/README.md

@@ -0,0 +1,281 @@
+<div align="center">
+
+# ⚡ fastapi-spawn
+
+**The most complete FastAPI project scaffolding CLI — built for modern Python development.**
+
+[![PyPI version](https://img.shields.io/pypi/v/fastapi-spawn.svg?color=cyan&style=flat-square)](https://pypi.org/project/fastapi-spawn/)
+[![Python](https://img.shields.io/pypi/pyversions/fastapi-spawn.svg?style=flat-square)](https://pypi.org/project/fastapi-spawn/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=flat-square)](LICENSE)
+[![CI](https://img.shields.io/github/actions/workflow/status/Bishwajitgarai/fastapi-spawn/tests.yml?label=tests&style=flat-square)](https://github.com/Bishwajitgarai/fastapi-spawn/actions)
+
+Generate production-ready FastAPI projects in seconds — with exactly the stack you need.
+
+</div>
+
+---
+
+## Installation
+
+```bash
+pip install fastapi-spawn
+# or
+uv pip install fastapi-spawn
+```
+
+---
+
+## Quick Start
+
+```bash
+# Interactive TUI — guided step-by-step
+fastapi-spawn new my-api
+
+# One-liner with all flags
+fastapi-spawn new my-api \
+  --db postgresql \
+  --orm sqlalchemy \
+  --migration alembic \
+  --auth jwt \
+  --broker redis \
+  --storage s3 \
+  --ai openai \
+  --monitoring sentry \
+  --email sendgrid \
+  --log-dest cloudwatch \
+  --vector-db qdrant \
+  --stack full \
+  --ci github
+
+# Preview file tree without writing
+fastapi-spawn new my-api --dry-run
+
+# Add a feature to an existing project
+fastapi-spawn add openai
+fastapi-spawn add alembic
+fastapi-spawn add sentry
+```
+
+---
+
+## What Gets Generated
+
+```
+my-api/
+├── app/
+│   ├── api/
+│   │   └── v1/
+│   │       ├── health.py        # GET /health  /readiness  /liveness
+│   │       └── auth.py          # POST /auth/login  /auth/refresh
+│   ├── core/
+│   │   ├── config.py            # Pydantic Settings v2 — individual env fields + @property URLs
+│   │   ├── logger.py            # Context-var logger — request ID, client IP, dual-timezone
+│   │   ├── exceptions.py        # Custom exception hierarchy + handlers
+│   │   ├── security.py          # JWT / bcrypt
+│   │   ├── storage.py           # AWS S3 / MinIO helpers
+│   │   ├── ai.py                # OpenAI / Anthropic / Gemini / Ollama async client
+│   │   ├── email.py             # SendGrid / SMTP / SES
+│   │   └── monitoring.py        # Sentry init / Prometheus metrics
+│   ├── middleware/
+│   │   ├── request_logger.py    # X-Request-ID, response time, structured logs
+│   │   └── rate_limit.py        # slowapi — 429 with Retry-After
+│   ├── db/
+│   │   └── session.py           # Async SQLAlchemy / Tortoise / Beanie
+│   ├── models/
+│   ├── schemas/
+│   ├── services/
+│   └── repositories/
+├── tasks/                       # Celery workers (root-level)
+│   ├── celery_app.py
+│   └── sample_tasks.py
+├── migrations/                  # Alembic (async-compatible)
+│   ├── env.py
+│   └── versions/
+├── infra/
+│   ├── docker/
+│   ├── helm/
+│   └── terraform/
+├── tests/
+├── logs/                        # Local log rotation directory
+├── main.py                      # uv run main.py
+├── alembic.ini
+├── Dockerfile                   # Uses uv for fast layer-cached builds
+├── docker-compose.yml           # All selected services pre-configured
+├── .env                         # gitignored
+├── .env.example
+├── .gitignore
+├── .pre-commit-config.yaml
+├── Makefile
+└── pyproject.toml               # uv-compatible with [tool.uv.scripts]
+```
+
+---
+
+## All Options
+
+```
+fastapi-spawn new [OPTIONS] PROJECT_NAME
+
+Database & ORM
+  --db           postgresql | mysql | mongodb | sqlite | none
+  --orm          sqlalchemy | tortoise | beanie | none
+  --migration    alembic | aerich | none
+
+Auth & Security
+  --auth         jwt | oauth2 | api-key | none
+
+Messaging & Cache
+  --broker       redis | rabbitmq | kafka | none
+  --cache        redis | memcached | none
+
+Storage
+  --storage      s3 | local | none          (s3 = AWS S3 or MinIO)
+
+AI / LLM
+  --ai           openai | anthropic | gemini | ollama | none
+
+Monitoring
+  --monitoring   sentry | prometheus | both | none
+
+Email
+  --email        sendgrid | smtp | ses | none
+
+Notifications
+  --notify       slack | discord | none
+
+Logging
+  --log-lib      loguru | structlog | standard
+  --log-dest     local | cloudwatch | datadog | none
+
+Vector Database
+  --vector-db    qdrant | pinecone | elasticsearch | none
+
+Deployment
+  --stack        minimal | standard | full
+  --ci           github | gitlab | both | none
+
+Flags
+  --no-docker    Skip Docker files
+  --no-tests     Skip test suite
+  --dry-run      Preview file tree without writing
+  --force / -f   Overwrite existing directory
+  --output / -o  Output directory
+```
+
+---
+
+## uv run Scripts
+
+Every generated project has `[tool.uv.scripts]` pre-wired:
+
+```bash
+uv run dev        # uvicorn --reload
+uv run start      # python main.py
+uv run test       # pytest --cov
+uv run lint       # ruff check
+uv run format     # ruff format
+uv run typecheck  # mypy
+uv run migrate    # alembic upgrade head  (if alembic)
+uv run rollback   # alembic downgrade -1  (if alembic)
+uv run makemig    # alembic revision --autogenerate  (if alembic)
+uv run worker     # celery worker  (if broker)
+uv run beat       # celery beat    (if broker)
+```
+
+---
+
+## Environment Variables
+
+Individual fields per service — **no URL strings**. URLs are assembled via `@property`:
+
+```env
+ENVIRONMENT=dev
+SECRET_KEY=super-secret-change-in-production
+
+# PostgreSQL
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
+POSTGRES_DB=my_api_db
+
+# Redis
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_PASSWORD=
+REDIS_DB=0
+
+# AWS S3 (or MinIO — set ENDPOINT_URL for local)
+AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
+AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG
+AWS_REGION=us-east-1
+AWS_S3_BUCKET=my-api-bucket
+AWS_S3_ENDPOINT_URL=http://localhost:9000   # MinIO local
+
+# OpenAI (supports custom base URL for Azure / LM Studio)
+OPENAI_API_KEY=sk-placeholder
+OPENAI_MODEL=gpt-4o
+OPENAI_BASE_URL=
+
+# Sentry
+SENTRY_DSN=https://xxx@sentry.io/yyy
+
+# Logging
+LOG_LEVEL=INFO
+LOG_DIR=logs
+LOG_BACKUP_DAYS=30
+```
+
+---
+
+## Add Features to Existing Projects
+
+```bash
+fastapi-spawn add sentry      # Sentry error tracking setup
+fastapi-spawn add openai      # OpenAI async client + env vars
+fastapi-spawn add alembic     # Alembic async migrations
+fastapi-spawn add s3          # AWS S3 / MinIO storage utils
+fastapi-spawn add celery      # Celery worker + tasks/
+fastapi-spawn add helm        # Helm chart in infra/helm/
+fastapi-spawn add terraform   # Terraform scaffold in infra/terraform/
+```
+
+---
+
+## ORM ↔ Database Compatibility
+
+| ORM | Compatible Databases |
+|---|---|
+| `sqlalchemy` | postgresql, mysql, sqlite |
+| `tortoise` | postgresql, mysql, sqlite |
+| `beanie` | mongodb |
+| `none` | any |
+
+---
+
+## Middleware Stack (always included)
+
+| Middleware | What it does |
+|---|---|
+| `RequestLoggingMiddleware` | Logs `→ METHOD /path` + `✓ status duration` with request ID |
+| `RateLimitMiddleware` | 200 req/min default via slowapi, returns 429 + `Retry-After` |
+| `CORSMiddleware` | Configurable via `CORS_ORIGINS` env var |
+
+Every response includes `X-Request-ID` and `X-Response-Time` headers.
+
+---
+
+## Contributing
+
+```bash
+git clone https://github.com/Bishwajitgarai/fastapi-spawn
+cd fastapi-spawn
+uv sync --all-extras
+uv run pytest
+```
+
+---
+
+## License
+
+MIT © [Bishwajit Garai](https://github.com/Bishwajitgarai)

{fastapi_spawn-0.1.0 → fastapi_spawn-0.2.0}/fastapi_spawn/__init__.py

@@ -1,6 +1,7 @@
 """fastapi-spawn — Production-ready FastAPI project scaffolding CLI."""
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"
 __author__ = "Bishwajit Garai"
 __email__ = "bishwajitgarai@gmail.com"
 __license__ = "MIT"
+__description__ = "Production-ready FastAPI project scaffolding — with every integration you need."