fastapi-spawn 0.1.0__tar.gz

fastapi_spawn-0.1.0/.gitignore

@@ -0,0 +1,53 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.pyd
+.Python
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+.eggs/
+MANIFEST
+
+# Secrets & environment variables
+.env
+.env.*
+!.env.example
+
+# Testing
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+.tox/
+
+# Type checking
+.mypy_cache/
+.dmypy.json
+
+# Ruff / linting
+.ruff_cache/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Hatch / build backends
+.hatch/

fastapi_spawn-0.1.0/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to `fastapi-spawn` will be documented here.
+
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+Versioning follows [Semantic Versioning](https://semver.org/).
+
+---
+
+## [0.1.0] — 2026-05-10
+
+### Added
+- Interactive TUI with questionary + Rich styling
+- Database support: PostgreSQL, MySQL, MongoDB, SQLite
+- ORM support: SQLAlchemy 2.x (async), Tortoise ORM, Beanie
+- Migration support: Alembic (async-compatible), Aerich
+- Auth: JWT, OAuth2, API Key
+- Message brokers: Redis (Celery), RabbitMQ (Celery), Kafka (aiokafka)
+- Cache layer: Redis, Memcached
+- File storage: AWS S3 (boto3) with presigned URLs
+- AI integration: OpenAI (chat + embeddings, custom base URL), Anthropic Claude
+- Root-level `main.py` entry point (`uv run main.py`)
+- Root-level `tasks/` directory for Celery workers
+- Individual env fields per service with `@property` URL assembly
+- `OPENAI_BASE_URL` support for Azure, LM Studio, local endpoints
+- `--dry-run` flag with rich tree preview
+- `--force` flag to overwrite existing projects
+- Stack options: minimal, standard, full (Helm + Terraform)
+- CI/CD: GitHub Actions, GitLab CI
+- Logging: loguru, structlog, standard library
+- Docker: multi-service compose with health checks
+- infra/: docker/, helm/, terraform/ structure
+- `uv`-compatible `pyproject.toml` with `[tool.uv]`
+- `list-templates` and `validate` subcommands
+- `ENVIRONMENT=dev` style env naming
+- Professional README, CHANGELOG, CONTRIBUTING

fastapi_spawn-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bishwajit Garai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_spawn-0.1.0/PKG-INFO

@@ -0,0 +1,262 @@
+Metadata-Version: 2.4
+Name: fastapi-spawn
+Version: 0.1.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
+Project-URL: Repository, https://github.com/Bishwajitgarai/fastapi-spawn
+Project-URL: Bug Tracker, https://github.com/Bishwajitgarai/fastapi-spawn/issues
+Project-URL: Changelog, https://github.com/Bishwajitgarai/fastapi-spawn/blob/main/CHANGELOG.md
+Author-email: Bishwajit Garai <bishwajitgarai@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: boilerplate,cli,devtools,docker,fastapi,generator,jwt,project-generator,python,scaffold,sqlalchemy,template
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1.0
+Requires-Dist: jinja2>=3.1.4
+Requires-Dist: questionary>=2.0.1
+Requires-Dist: rich>=13.7.0
+Requires-Dist: tomli>=2.0.1; python_version < '3.11'
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.7.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<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)
+
+</div>
+
+---
+
+## 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 |
+
+---
+
+## Installation
+
+```bash
+pip install fastapi-spawn
+# or
+uv pip install fastapi-spawn
+```
+
+---
+
+## Quick Start
+
+```bash
+# Fully interactive — guided TUI
+fastapi-spawn new my-api
+
+# One-liner (all flags)
+fastapi-spawn new my-api \
+  --db postgresql \
+  --orm sqlalchemy \
+  --migration alembic \
+  --auth jwt \
+  --broker redis \
+  --storage s3 \
+  --ai openai \
+  --stack full \
+  --ci github \
+  --log-lib loguru
+
+# Preview without writing files
+fastapi-spawn new my-api --dry-run
+```
+
+---
+
+## Generated Project Structure
+
+```
+my-api/
+├── app/
+│   ├── api/
+│   │   └── v1/
+│   │       ├── health.py        # /health  /readiness  /liveness
+│   │       └── auth.py          # JWT login + 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)
+│   ├── db/
+│   │   └── session.py           # Async SQLAlchemy / Tortoise / Beanie
+│   ├── models/                  # ORM models
+│   ├── schemas/                 # Pydantic schemas
+│   ├── services/                # Business logic layer
+│   └── repositories/            # Data access layer
+├── tasks/                       # Celery workers (root-level)
+│   ├── celery_app.py
+│   └── sample_tasks.py
+├── migrations/                  # Alembic migrations
+│   ├── env.py                   # Async-compatible env
+│   └── versions/
+├── infra/
+│   ├── docker/
+│   ├── helm/
+│   └── terraform/
+├── tests/
+│   ├── conftest.py
+│   └── test_health.py
+├── main.py                      # uv run main.py entry point
+├── alembic.ini
+├── Dockerfile                   # Uses uv for fast builds
+├── docker-compose.yml           # All 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
+```
+
+---
+
+## All Options
+
+```
+fastapi-spawn new [OPTIONS] PROJECT_NAME
+
+  --db           postgresql | mysql | mongodb | sqlite | none
+  --orm          sqlalchemy | tortoise | beanie | none
+  --migration    alembic | aerich | none
+  --auth         jwt | oauth2 | api-key | none
+  --broker       redis | rabbitmq | kafka | none
+  --cache        redis | memcached | none
+  --storage      s3 | local | none
+  --ai           openai | anthropic | none
+  --stack        minimal | standard | full
+  --ci           github | gitlab | both | none
+  --log-lib      loguru | structlog | standard
+  --no-docker    Skip Docker files
+  --no-tests     Skip test suite
+  --dry-run      Preview file tree only
+  --force / -f   Overwrite existing directory
+  --output / -o  Output directory (default: .)
+```
+
+### Subcommands
+
+```bash
+fastapi-spawn list-templates   # Show all options + ORM/DB compatibility
+fastapi-spawn validate FILE    # Validate a .fastapi-spawn.toml
+```
+
+---
+
+## After Scaffolding
+
+```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
+```
+
+---
+
+## ORM ↔ Database Compatibility
+
+| ORM | Compatible Databases |
+|---|---|
+| `sqlalchemy` | postgresql, mysql, sqlite |
+| `tortoise` | postgresql, mysql, sqlite |
+| `beanie` | mongodb |
+| `none` | any |
+
+---
+
+## Contributing
+
+```bash
+git clone https://github.com/Bishwajitgarai/fastapi-spawn
+cd fastapi-spawn
+uv sync --all-extras
+uv run pytest
+```
+
+PRs are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## License
+
+MIT © [Bishwajit Garai](https://github.com/Bishwajitgarai)

fastapi_spawn-0.1.0/README.md

@@ -0,0 +1,221 @@
+<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)
+
+</div>
+
+---
+
+## 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 |
+
+---
+
+## Installation
+
+```bash
+pip install fastapi-spawn
+# or
+uv pip install fastapi-spawn
+```
+
+---
+
+## Quick Start
+
+```bash
+# Fully interactive — guided TUI
+fastapi-spawn new my-api
+
+# One-liner (all flags)
+fastapi-spawn new my-api \
+  --db postgresql \
+  --orm sqlalchemy \
+  --migration alembic \
+  --auth jwt \
+  --broker redis \
+  --storage s3 \
+  --ai openai \
+  --stack full \
+  --ci github \
+  --log-lib loguru
+
+# Preview without writing files
+fastapi-spawn new my-api --dry-run
+```
+
+---
+
+## Generated Project Structure
+
+```
+my-api/
+├── app/
+│   ├── api/
+│   │   └── v1/
+│   │       ├── health.py        # /health  /readiness  /liveness
+│   │       └── auth.py          # JWT login + 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)
+│   ├── db/
+│   │   └── session.py           # Async SQLAlchemy / Tortoise / Beanie
+│   ├── models/                  # ORM models
+│   ├── schemas/                 # Pydantic schemas
+│   ├── services/                # Business logic layer
+│   └── repositories/            # Data access layer
+├── tasks/                       # Celery workers (root-level)
+│   ├── celery_app.py
+│   └── sample_tasks.py
+├── migrations/                  # Alembic migrations
+│   ├── env.py                   # Async-compatible env
+│   └── versions/
+├── infra/
+│   ├── docker/
+│   ├── helm/
+│   └── terraform/
+├── tests/
+│   ├── conftest.py
+│   └── test_health.py
+├── main.py                      # uv run main.py entry point
+├── alembic.ini
+├── Dockerfile                   # Uses uv for fast builds
+├── docker-compose.yml           # All 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
+```
+
+---
+
+## All Options
+
+```
+fastapi-spawn new [OPTIONS] PROJECT_NAME
+
+  --db           postgresql | mysql | mongodb | sqlite | none
+  --orm          sqlalchemy | tortoise | beanie | none
+  --migration    alembic | aerich | none
+  --auth         jwt | oauth2 | api-key | none
+  --broker       redis | rabbitmq | kafka | none
+  --cache        redis | memcached | none
+  --storage      s3 | local | none
+  --ai           openai | anthropic | none
+  --stack        minimal | standard | full
+  --ci           github | gitlab | both | none
+  --log-lib      loguru | structlog | standard
+  --no-docker    Skip Docker files
+  --no-tests     Skip test suite
+  --dry-run      Preview file tree only
+  --force / -f   Overwrite existing directory
+  --output / -o  Output directory (default: .)
+```
+
+### Subcommands
+
+```bash
+fastapi-spawn list-templates   # Show all options + ORM/DB compatibility
+fastapi-spawn validate FILE    # Validate a .fastapi-spawn.toml
+```
+
+---
+
+## After Scaffolding
+
+```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
+```
+
+---
+
+## ORM ↔ Database Compatibility
+
+| ORM | Compatible Databases |
+|---|---|
+| `sqlalchemy` | postgresql, mysql, sqlite |
+| `tortoise` | postgresql, mysql, sqlite |
+| `beanie` | mongodb |
+| `none` | any |
+
+---
+
+## Contributing
+
+```bash
+git clone https://github.com/Bishwajitgarai/fastapi-spawn
+cd fastapi-spawn
+uv sync --all-extras
+uv run pytest
+```
+
+PRs are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## License
+
+MIT © [Bishwajit Garai](https://github.com/Bishwajitgarai)

fastapi_spawn-0.1.0/fastapi_spawn/__init__.py

@@ -0,0 +1,6 @@
+"""fastapi-spawn — Production-ready FastAPI project scaffolding CLI."""
+
+__version__ = "0.1.0"
+__author__ = "Bishwajit Garai"
+__email__ = "bishwajitgarai@gmail.com"
+__license__ = "MIT"