fastapi-spawn 0.1.0__py3-none-any.whl

fastapi_spawn/templates/base/Makefile.j2

@@ -0,0 +1,45 @@
+.PHONY: help install dev run test lint format clean
+
+help:  ## Show this help
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+install:  ## Install dependencies
+	pip install -e .
+
+dev:  ## Install dev dependencies
+	pip install -e ".[dev]"
+
+run:  ## Run development server
+	uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
+
+{% if include_tests %}
+test:  ## Run tests
+	pytest --cov=app --cov-report=term-missing
+
+test-ci:  ## Run tests with XML report
+	pytest --cov=app --cov-report=xml
+{% endif %}
+
+lint:  ## Run linters
+	ruff check .
+	mypy app/
+
+format:  ## Auto-format code
+	ruff format .
+	ruff check --fix .
+
+clean:  ## Remove build artifacts
+	find . -type d -name __pycache__ -exec rm -rf {} +
+	find . -type f -name "*.pyc" -delete
+	rm -rf dist/ build/ *.egg-info .pytest_cache .coverage htmlcov/
+
+{% if has_docker %}
+docker-build:  ## Build Docker image
+	docker build -t {{ slug }} .
+
+docker-up:  ## Start all services
+	docker compose up --build
+
+docker-down:  ## Stop all services
+	docker compose down
+{% endif %}

fastapi_spawn/templates/base/README.md.j2

@@ -0,0 +1,74 @@
+# {{ project_name }}
+
+> Auto-generated by [fastapi-spawn](https://github.com/Bishwajitgarai/fastapi-spawn) 🚀
+
+## Stack
+
+| Component | Choice |
+|-----------|--------|
+| Database | `{{ db }}` |
+| ORM / ODM | `{{ orm }}` |
+| Auth | `{{ auth }}` |
+| Broker | `{{ broker }}` |
+| Cache | `{{ cache }}` |
+| Stack | `{{ stack }}` |
+| Logging | `{{ log_lib }}` |
+
+## Getting Started
+
+```bash
+# 1. Create virtual environment
+python -m venv .venv
+source .venv/bin/activate  # Windows: .venv\Scripts\activate
+
+# 2. Install dependencies
+pip install -e ".[dev]"
+
+# 3. Copy env file and fill in values
+cp .env.example .env
+
+{% if has_docker %}
+# 4. Start with Docker
+docker compose up --build
+{% else %}
+# 4. Run locally
+uvicorn app.main:app --reload
+{% endif %}
+```
+
+## API Endpoints
+
+| Method | Path | Description |
+|--------|------|-------------|
+| GET | `/health` | Health check |
+| GET | `/api/v1/health/readiness` | Readiness probe |
+| GET | `/api/v1/health/liveness` | Liveness probe |
+{% if has_auth %}
+| POST | `/api/v1/auth/login` | Obtain token |
+| POST | `/api/v1/auth/refresh` | Refresh token |
+{% endif %}
+
+## Project Structure
+
+```
+{{ project_name }}/
+├── app/
+│   ├── main.py          # FastAPI application entrypoint
+│   ├── core/            # Config, logging, security
+│   ├── api/v1/          # Versioned route handlers
+│   ├── models/          # ORM models
+│   ├── schemas/         # Pydantic schemas
+│   ├── services/        # Business logic
+│   └── repositories/    # Data access layer
+{% if include_tests %}
+├── tests/               # pytest test suite
+{% endif %}
+{% if has_docker %}
+├── Dockerfile
+└── docker-compose.yml
+{% endif %}
+```
+
+## License
+
+MIT

fastapi_spawn/templates/base/env.j2

@@ -0,0 +1,82 @@
+# Application
+APP_NAME="{{ project_name }}"
+ENVIRONMENT=dev
+DEBUG=true
+SECRET_KEY=super-secret-change-in-production
+API_V1_PREFIX=/api/v1
+CORS_ORIGINS=http://localhost:3000,http://localhost:8000
+
+{% if db == "postgresql" %}
+# PostgreSQL
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
+POSTGRES_DB={{ slug }}_db
+{% endif %}
+{% if db == "mysql" %}
+# MySQL
+MYSQL_USER=root
+MYSQL_PASSWORD=mysql
+MYSQL_HOST=localhost
+MYSQL_PORT=3306
+MYSQL_DB={{ slug }}_db
+{% endif %}
+{% if db == "sqlite" %}
+# SQLite
+SQLITE_FILE={{ slug }}.db
+{% endif %}
+{% if has_mongo %}
+# MongoDB
+MONGODB_USER=mongo
+MONGODB_PASSWORD=mongo
+MONGODB_HOST=localhost
+MONGODB_PORT=27017
+MONGODB_DB={{ slug }}_db
+{% endif %}
+{% if broker == "redis" or cache == "redis" %}
+# Redis
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_PASSWORD=
+REDIS_DB=0
+{% endif %}
+{% if broker == "rabbitmq" %}
+# RabbitMQ
+RABBITMQ_USER=guest
+RABBITMQ_PASSWORD=guest
+RABBITMQ_HOST=localhost
+RABBITMQ_PORT=5672
+RABBITMQ_VHOST=/
+{% endif %}
+{% if broker == "kafka" %}
+# Kafka
+KAFKA_HOST=localhost
+KAFKA_PORT=9092
+{% endif %}
+{% if has_s3 %}
+# AWS S3
+AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
+AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+AWS_REGION=us-east-1
+AWS_S3_BUCKET={{ slug }}-bucket
+AWS_S3_ENDPOINT_URL=
+{% endif %}
+{% if has_auth %}
+# Auth / JWT
+ACCESS_TOKEN_EXPIRE_MINUTES=30
+REFRESH_TOKEN_EXPIRE_DAYS=7
+ALGORITHM=HS256
+{% endif %}
+{% if ai == "openai" %}
+# OpenAI
+OPENAI_API_KEY=sk-placeholder
+OPENAI_MODEL=gpt-4o
+OPENAI_EMBEDDING_MODEL=text-embedding-3-small
+OPENAI_BASE_URL=                        # leave blank for api.openai.com; set for Azure / LM Studio / local
+{% endif %}
+{% if ai == "anthropic" %}
+# Anthropic
+ANTHROPIC_API_KEY=sk-ant-placeholder
+ANTHROPIC_MODEL=claude-3-5-sonnet-20241022
+{% endif %}

fastapi_spawn/templates/base/env_example.j2

@@ -0,0 +1,85 @@
+# Copy this file to .env and fill in real values.
+# NEVER commit .env to version control.
+
+# Application
+APP_NAME="{{ project_name }}"
+ENVIRONMENT=dev
+DEBUG=true
+SECRET_KEY=CHANGE_ME
+API_V1_PREFIX=/api/v1
+CORS_ORIGINS=http://localhost:3000,http://localhost:8000
+
+{% if db == "postgresql" %}
+# PostgreSQL
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=CHANGE_ME
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
+POSTGRES_DB={{ slug }}_db
+{% endif %}
+{% if db == "mysql" %}
+# MySQL
+MYSQL_USER=root
+MYSQL_PASSWORD=CHANGE_ME
+MYSQL_HOST=localhost
+MYSQL_PORT=3306
+MYSQL_DB={{ slug }}_db
+{% endif %}
+{% if db == "sqlite" %}
+# SQLite
+SQLITE_FILE={{ slug }}.db
+{% endif %}
+{% if has_mongo %}
+# MongoDB
+MONGODB_USER=mongo
+MONGODB_PASSWORD=CHANGE_ME
+MONGODB_HOST=localhost
+MONGODB_PORT=27017
+MONGODB_DB={{ slug }}_db
+{% endif %}
+{% if broker == "redis" or cache == "redis" %}
+# Redis
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_PASSWORD=
+REDIS_DB=0
+{% endif %}
+{% if broker == "rabbitmq" %}
+# RabbitMQ
+RABBITMQ_USER=guest
+RABBITMQ_PASSWORD=CHANGE_ME
+RABBITMQ_HOST=localhost
+RABBITMQ_PORT=5672
+RABBITMQ_VHOST=/
+{% endif %}
+{% if broker == "kafka" %}
+# Kafka
+KAFKA_HOST=localhost
+KAFKA_PORT=9092
+{% endif %}
+{% if has_s3 %}
+# AWS S3
+AWS_ACCESS_KEY_ID=CHANGE_ME
+AWS_SECRET_ACCESS_KEY=CHANGE_ME
+AWS_REGION=us-east-1
+AWS_S3_BUCKET={{ slug }}-bucket
+AWS_S3_ENDPOINT_URL=
+{% endif %}
+{% if has_auth %}
+# Auth / JWT
+ACCESS_TOKEN_EXPIRE_MINUTES=30
+REFRESH_TOKEN_EXPIRE_DAYS=7
+ALGORITHM=HS256
+{% endif %}
+{% if ai == "openai" %}
+# OpenAI
+OPENAI_API_KEY=sk-placeholder
+OPENAI_MODEL=gpt-4o
+OPENAI_EMBEDDING_MODEL=text-embedding-3-small
+OPENAI_BASE_URL=                        # leave blank for api.openai.com; set for Azure / LM Studio / local
+{% endif %}
+{% if ai == "anthropic" %}
+# Anthropic
+ANTHROPIC_API_KEY=sk-ant-placeholder
+ANTHROPIC_MODEL=claude-3-5-sonnet-20241022
+{% endif %}

fastapi_spawn/templates/base/gitignore.j2

@@ -0,0 +1,38 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+
+# Envs
+.venv/
+venv/
+env/
+
+# Distribution
+dist/
+build/
+*.egg-info/
+
+# Secrets
+.env
+.env.*
+!.env.example
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+coverage.xml
+
+# Type checking
+.mypy_cache/
+
+# IDE
+.vscode/
+.idea/
+
+# OS
+.DS_Store
+Thumbs.db

fastapi_spawn/templates/base/pre_commit.j2

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.4
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: detect-private-key

fastapi_spawn/templates/base/pyproject.toml.j2

@@ -0,0 +1,129 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "{{ project_name }}"
+version = "0.1.0"
+description = "A production-ready FastAPI application"
+requires-python = ">=3.10"
+authors = [{ name = "Your Name", email = "you@example.com" }]
+dependencies = [
+    "fastapi>=0.111.0",
+    "uvicorn[standard]>=0.29.0",
+    "pydantic>=2.7.0",
+    "pydantic-settings>=2.2.0",
+{% if log_lib == "loguru" %}
+    "loguru>=0.7.2",
+{% elif log_lib == "structlog" %}
+    "structlog>=24.1.0",
+{% endif %}
+{% if has_relational_db and orm == "sqlalchemy" %}
+    "sqlalchemy[asyncio]>=2.0.0",
+{% if db == "postgresql" %}
+    "asyncpg>=0.29.0",
+{% elif db == "mysql" %}
+    "aiomysql>=0.2.0",
+{% elif db == "sqlite" %}
+    "aiosqlite>=0.20.0",
+{% endif %}
+{% endif %}
+{% if has_relational_db and orm == "tortoise" %}
+    "tortoise-orm>=0.21.0",
+{% endif %}
+{% if has_migration and migration == "alembic" %}
+    "alembic>=1.13.0",
+{% elif has_migration and migration == "aerich" %}
+    "aerich>=0.7.2",
+{% endif %}
+{% if has_mongo and orm == "beanie" %}
+    "beanie>=1.25.0",
+    "motor>=3.4.0",
+{% endif %}
+{% if auth == "jwt" or auth == "oauth2" %}
+    "python-jose[cryptography]>=3.3.0",
+    "passlib[bcrypt]>=1.7.4",
+    "python-multipart>=0.0.9",
+{% elif auth == "api-key" %}
+    "python-multipart>=0.0.9",
+{% endif %}
+{% if broker == "redis" or broker == "rabbitmq" %}
+    "celery[redis]>=5.3.6",
+{% elif broker == "kafka" %}
+    "aiokafka>=0.10.0",
+{% endif %}
+{% if cache == "redis" or broker == "redis" %}
+    "redis[hiredis]>=5.0.0",
+{% elif cache == "memcached" %}
+    "aiomcache>=0.8.0",
+{% endif %}
+{% if has_s3 %}
+    "boto3>=1.34.0",
+{% endif %}
+{% if ai == "openai" %}
+    "openai>=1.30.0",
+{% elif ai == "anthropic" %}
+    "anthropic>=0.28.0",
+{% endif %}
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23.0",
+    "pytest-cov>=5.0.0",
+    "httpx>=0.27.0",
+    "anyio>=4.3.0",
+    "ruff>=0.4.0",
+    "mypy>=1.10.0",
+    "pre-commit>=3.7.0",
+]
+
+[tool.uv]
+dev-dependencies = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23.0",
+    "pytest-cov>=5.0.0",
+    "httpx>=0.27.0",
+    "anyio>=4.3.0",
+    "ruff>=0.4.0",
+    "mypy>=1.10.0",
+    "pre-commit>=3.7.0",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+addopts = "--cov=app --cov-report=term-missing"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+ignore = ["E501"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+ignore_missing_imports = true
+
+# ── uv run scripts ─────────────────────────────────────────────────────────
+# Usage: uv run <script-name>
+[tool.uv.scripts]
+dev      = "uvicorn app.main:app --reload --host 0.0.0.0 --port 8000"
+start    = "python main.py"
+test     = "pytest --cov=app --cov-report=term-missing"
+lint     = "ruff check ."
+format   = "ruff format ."
+typecheck = "mypy app/"
+{% if has_alembic %}
+migrate  = "alembic upgrade head"
+rollback = "alembic downgrade -1"
+makemig  = "alembic revision --autogenerate -m"
+{% endif %}
+{% if has_broker %}
+worker   = "celery -A tasks.celery_app worker --loglevel=info"
+beat     = "celery -A tasks.celery_app beat --loglevel=info"
+{% endif %}

fastapi_spawn/templates/ci/github/publish.yml.j2

@@ -0,0 +1,32 @@
+name: Publish Docker Image
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Log in to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ "{{" }} github.actor {{ "}}" }}
+          password: ${{ "{{" }} secrets.GITHUB_TOKEN {{ "}}" }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: |
+            ghcr.io/${{ "{{" }} github.repository {{ "}}" }}:latest
+            ghcr.io/${{ "{{" }} github.repository {{ "}}" }}:${{ "{{" }} github.ref_name {{ "}}" }}

fastapi_spawn/templates/ci/github/tests.yml.j2

@@ -0,0 +1,39 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ "{{" }} matrix.python-version {{ "}}" }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ "{{" }} matrix.python-version {{ "}}" }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Lint with ruff
+        run: uv run ruff check .
+
+      - name: Run tests
+        run: uv run pytest --cov=app --cov-report=xml
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          file: coverage.xml

fastapi_spawn/templates/ci/gitlab/gitlab-ci.yml.j2

@@ -0,0 +1,29 @@
+stages:
+  - test
+  - build
+
+test:
+  stage: test
+  image: python:3.12-slim
+  before_script:
+    - pip install uv
+    - uv sync --all-extras
+  script:
+    - uv run ruff check .
+    - uv run pytest --cov=app --cov-report=xml
+  coverage: '/TOTAL.*\s+(\d+%)$/'
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+
+build:
+  stage: build
+  image: docker:latest
+  services:
+    - docker:dind
+  script:
+    - docker build -t {{ slug }}:latest .
+  only:
+    - tags

fastapi_spawn/templates/docker/Dockerfile.j2

@@ -0,0 +1,17 @@
+FROM python:3.12-slim
+
+# Install uv
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
+
+WORKDIR /app
+
+# Install deps first for layer caching
+COPY pyproject.toml ./
+RUN uv sync --no-dev --frozen
+
+# Copy source
+COPY . .
+
+EXPOSE 8000
+
+CMD ["uv", "run", "main.py"]

fastapi_spawn/templates/docker/docker-compose.yml.j2

@@ -0,0 +1,97 @@
+services:
+  app:
+    build: .
+    ports:
+      - "8000:8000"
+    env_file:
+      - .env
+    depends_on:
+{% if has_relational_db and db == "postgresql" %}
+      - postgres
+{% endif %}
+{% if has_mongo %}
+      - mongodb
+{% endif %}
+{% if broker == "redis" or cache == "redis" %}
+      - redis
+{% endif %}
+{% if broker == "rabbitmq" %}
+      - rabbitmq
+{% endif %}
+    volumes:
+      - .:/app
+    restart: unless-stopped
+
+{% if has_broker and broker != "kafka" %}
+  worker:
+    build: .
+    command: celery -A tasks.celery_app worker --loglevel=info --concurrency=2
+    env_file:
+      - .env
+    depends_on:
+      - app
+    restart: unless-stopped
+{% endif %}
+
+{% if has_relational_db and db == "postgresql" %}
+  postgres:
+    image: postgres:16-alpine
+    environment:
+      POSTGRES_DB: {{ slug }}_db
+      POSTGRES_USER: user
+      POSTGRES_PASSWORD: password
+    ports:
+      - "5432:5432"
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U user -d {{ slug }}_db"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+{% endif %}
+
+{% if has_mongo %}
+  mongodb:
+    image: mongo:7
+    ports:
+      - "27017:27017"
+    volumes:
+      - mongo_data:/data/db
+{% endif %}
+
+{% if broker == "redis" or cache == "redis" %}
+  redis:
+    image: redis:7-alpine
+    ports:
+      - "6379:6379"
+    volumes:
+      - redis_data:/data
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 10s
+      timeout: 3s
+      retries: 3
+{% endif %}
+
+{% if broker == "rabbitmq" %}
+  rabbitmq:
+    image: rabbitmq:3-management-alpine
+    ports:
+      - "5672:5672"
+      - "15672:15672"
+    environment:
+      RABBITMQ_DEFAULT_USER: guest
+      RABBITMQ_DEFAULT_PASS: guest
+{% endif %}
+
+volumes:
+{% if has_relational_db and db == "postgresql" %}
+  postgres_data:
+{% endif %}
+{% if has_mongo %}
+  mongo_data:
+{% endif %}
+{% if broker == "redis" or cache == "redis" %}
+  redis_data:
+{% endif %}

fastapi_spawn/templates/docker/dockerignore.j2

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+.venv/
+.env
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.coverage
+htmlcov/
+.mypy_cache/
+.ruff_cache/
+.DS_Store