fastapi-fullstack 0.1.2__py3-none-any.whl

fastapi_gen/template/cookiecutter.json

@@ -0,0 +1,76 @@
+{
+  "project_name": "my_project",
+  "project_slug": "{{ cookiecutter.project_name.lower().replace('-', '_') }}",
+  "project_description": "A FastAPI project",
+  "author_name": "Your Name",
+  "author_email": "your@email.com",
+  "database": "postgresql",
+  "use_postgresql": true,
+  "use_mongodb": false,
+  "use_sqlite": false,
+  "use_database": true,
+  "db_pool_size": 5,
+  "db_max_overflow": 10,
+  "db_pool_timeout": 30,
+  "auth": "jwt",
+  "use_jwt": true,
+  "use_api_key": false,
+  "use_auth": true,
+  "oauth_provider": "none",
+  "enable_oauth": false,
+  "enable_oauth_google": false,
+  "enable_session_management": false,
+  "enable_logfire": true,
+  "logfire_fastapi": true,
+  "logfire_database": true,
+  "logfire_redis": false,
+  "logfire_celery": false,
+  "logfire_httpx": false,
+  "background_tasks": "none",
+  "use_celery": false,
+  "use_taskiq": false,
+  "use_arq": false,
+  "enable_redis": false,
+  "enable_caching": false,
+  "enable_rate_limiting": false,
+  "rate_limit_requests": 100,
+  "rate_limit_period": 60,
+  "enable_pagination": true,
+  "enable_sentry": false,
+  "enable_prometheus": false,
+  "enable_admin_panel": false,
+  "admin_environments": "dev_staging",
+  "admin_env_all": false,
+  "admin_env_dev_only": false,
+  "admin_env_dev_staging": true,
+  "admin_env_disabled": false,
+  "admin_require_auth": true,
+  "enable_websockets": false,
+  "enable_file_storage": false,
+  "enable_ai_agent": false,
+  "enable_conversation_persistence": false,
+  "enable_webhooks": false,
+  "websocket_auth": "none",
+  "websocket_auth_jwt": false,
+  "websocket_auth_api_key": false,
+  "websocket_auth_none": true,
+  "enable_cors": true,
+  "enable_orjson": true,
+  "enable_i18n": false,
+  "include_example_crud": true,
+  "enable_pytest": true,
+  "enable_precommit": true,
+  "enable_makefile": true,
+  "enable_docker": true,
+  "ci_type": "github",
+  "use_github_actions": true,
+  "use_gitlab_ci": false,
+  "enable_kubernetes": false,
+  "generate_env": true,
+  "python_version": "3.12",
+  "frontend": "none",
+  "use_frontend": false,
+  "use_nextjs": false,
+  "frontend_port": 3000,
+  "backend_port": 8000
+}

fastapi_gen/template/hooks/post_gen_project.py

@@ -0,0 +1,111 @@
+#!/usr/bin/env python
+"""Post-generation hook for cookiecutter template."""
+
+import os
+import shutil
+import subprocess
+import sys
+
+# Get cookiecutter variables
+use_frontend = "{{ cookiecutter.use_frontend }}" == "True"
+generate_env = "{{ cookiecutter.generate_env }}" == "True"
+
+# Remove frontend folder if not using frontend
+if not use_frontend:
+    frontend_dir = os.path.join(os.getcwd(), "frontend")
+    if os.path.exists(frontend_dir):
+        shutil.rmtree(frontend_dir)
+        print("Removed frontend/ directory (frontend not enabled)")
+
+# Remove .env files if generate_env is false
+if not generate_env:
+    backend_env = os.path.join(os.getcwd(), "backend", ".env")
+    if os.path.exists(backend_env):
+        os.remove(backend_env)
+        print("Removed backend/.env (generate_env disabled)")
+
+    frontend_env = os.path.join(os.getcwd(), "frontend", ".env.local")
+    if os.path.exists(frontend_env):
+        os.remove(frontend_env)
+        print("Removed frontend/.env.local (generate_env disabled)")
+
+# Run ruff to auto-fix import sorting and other linting issues
+backend_dir = os.path.join(os.getcwd(), "backend")
+if os.path.exists(backend_dir):
+    ruff_cmd = None
+
+    # Try multiple methods to find/run ruff
+    # 1. Check if ruff is in PATH
+    ruff_path = shutil.which("ruff")
+    if ruff_path:
+        ruff_cmd = [ruff_path]
+    # 2. Try uvx ruff (if uv is installed)
+    elif shutil.which("uvx"):
+        ruff_cmd = ["uvx", "ruff"]
+    # 3. Try python -m ruff
+    else:
+        # Test if ruff is available as a module
+        result = subprocess.run(
+            [sys.executable, "-m", "ruff", "--version"],
+            capture_output=True,
+            check=False,
+        )
+        if result.returncode == 0:
+            ruff_cmd = [sys.executable, "-m", "ruff"]
+
+    if ruff_cmd:
+        print(f"Running ruff to format code (using: {' '.join(ruff_cmd)})...")
+        # Run ruff check --fix to auto-fix issues
+        subprocess.run(
+            [*ruff_cmd, "check", "--fix", "--quiet", backend_dir],
+            check=False,
+        )
+        # Run ruff format for consistent formatting
+        subprocess.run(
+            [*ruff_cmd, "format", "--quiet", backend_dir],
+            check=False,
+        )
+        print("Code formatting complete.")
+    else:
+        print("Warning: ruff not found. Run 'ruff format .' in backend/ to format code.")
+
+# Format frontend with prettier if it exists
+frontend_dir = os.path.join(os.getcwd(), "frontend")
+if use_frontend and os.path.exists(frontend_dir):
+    # Try to find bun or npx for running prettier
+    bun_cmd = shutil.which("bun")
+    npx_cmd = shutil.which("npx")
+
+    if bun_cmd:
+        print("Installing frontend dependencies and formatting with Prettier...")
+        # Install dependencies first (prettier is a devDependency)
+        result = subprocess.run(
+            [bun_cmd, "install"],
+            cwd=frontend_dir,
+            capture_output=True,
+            check=False,
+        )
+        if result.returncode == 0:
+            # Format with prettier
+            subprocess.run(
+                [bun_cmd, "run", "format"],
+                cwd=frontend_dir,
+                capture_output=True,
+                check=False,
+            )
+            print("Frontend formatting complete.")
+        else:
+            print("Warning: Failed to install frontend dependencies.")
+    elif npx_cmd:
+        print("Formatting frontend with Prettier...")
+        subprocess.run(
+            [npx_cmd, "prettier", "--write", "."],
+            cwd=frontend_dir,
+            capture_output=True,
+            check=False,
+        )
+        print("Frontend formatting complete.")
+    else:
+        print("Warning: bun/npx not found. Run 'bun run format' in frontend/ to format code.")
+
+print("Project generated successfully!")

fastapi_gen/template/{{cookiecutter.project_slug}}/.env.example

@@ -0,0 +1,136 @@
+# {{ cookiecutter.project_name }} Environment Variables
+
+# === Project ===
+PROJECT_NAME={{ cookiecutter.project_name }}
+DEBUG=true
+ENVIRONMENT=local
+
+{%- if cookiecutter.enable_logfire %}
+
+# === Logfire ===
+# Get your token at https://logfire.pydantic.dev
+LOGFIRE_TOKEN=
+LOGFIRE_SERVICE_NAME={{ cookiecutter.project_slug }}
+LOGFIRE_ENVIRONMENT=development
+{%- endif %}
+
+{%- if cookiecutter.use_postgresql %}
+
+# === PostgreSQL ===
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_DB={{ cookiecutter.project_slug }}
+{%- endif %}
+
+{%- if cookiecutter.use_mongodb %}
+
+# === MongoDB ===
+MONGO_HOST=localhost
+MONGO_PORT=27017
+MONGO_DB={{ cookiecutter.project_slug }}
+# MONGO_USER=
+# MONGO_PASSWORD=
+{%- endif %}
+
+{%- if cookiecutter.use_sqlite %}
+
+# === SQLite ===
+SQLITE_PATH=./{{ cookiecutter.project_slug }}.db
+{%- endif %}
+
+{%- if cookiecutter.use_jwt %}
+
+# === JWT Auth ===
+# Generate with: openssl rand -hex 32
+SECRET_KEY=change-me-in-production-use-openssl-rand-hex-32
+ACCESS_TOKEN_EXPIRE_MINUTES=10080
+ALGORITHM=HS256
+{%- endif %}
+
+{%- if cookiecutter.use_api_key %}
+
+# === API Key Auth ===
+API_KEY=change-me-in-production
+API_KEY_HEADER=X-API-Key
+{%- endif %}
+
+{%- if cookiecutter.enable_redis %}
+
+# === Redis ===
+REDIS_HOST=localhost
+REDIS_PORT=6379
+# REDIS_PASSWORD=
+REDIS_DB=0
+{%- endif %}
+
+{%- if cookiecutter.use_celery %}
+
+# === Celery ===
+CELERY_BROKER_URL=redis://localhost:6379/0
+CELERY_RESULT_BACKEND=redis://localhost:6379/0
+{%- endif %}
+
+{%- if cookiecutter.use_taskiq %}
+
+# === Taskiq ===
+TASKIQ_BROKER_URL=redis://localhost:6379/1
+TASKIQ_RESULT_BACKEND=redis://localhost:6379/1
+{%- endif %}
+
+{%- if cookiecutter.enable_sentry %}
+
+# === Sentry ===
+SENTRY_DSN=
+{%- endif %}
+
+{%- if cookiecutter.enable_file_storage %}
+
+# === S3/MinIO Storage ===
+S3_ENDPOINT=
+S3_ACCESS_KEY=
+S3_SECRET_KEY=
+S3_BUCKET={{ cookiecutter.project_slug }}
+S3_REGION=us-east-1
+{%- endif %}
+
+{%- if cookiecutter.enable_ai_agent %}
+
+# === AI Agent (PydanticAI) ===
+OPENAI_API_KEY=
+AI_MODEL=gpt-4o-mini
+AI_TEMPERATURE=0.7
+{%- endif %}
+
+{%- if cookiecutter.enable_cors %}
+
+# === CORS ===
+# JSON list of allowed origins (default: localhost:3000, localhost:8080)
+# Note: "*" is blocked in production - specify explicit origins
+CORS_ORIGINS=["http://localhost:3000","http://localhost:8080"]
+{%- endif %}
+
+{%- if cookiecutter.enable_docker %}
+
+# === Docker Production (Traefik) ===
+# Domain for production deployment
+DOMAIN=example.com
+
+# Let's Encrypt email for SSL certificates
+ACME_EMAIL=admin@example.com
+
+# Traefik dashboard auth (generate with: htpasswd -nb admin password)
+# TRAEFIK_DASHBOARD_AUTH=admin:$$apr1$$...
+
+{%- if cookiecutter.enable_redis %}
+# Redis password for production
+REDIS_PASSWORD=change-me-in-production
+{%- endif %}
+
+{%- if cookiecutter.use_celery %}
+# Flower monitoring credentials
+FLOWER_USER=admin
+FLOWER_PASSWORD=change-me-in-production
+{%- endif %}
+{%- endif %}

fastapi_gen/template/{{cookiecutter.project_slug}}/.github/workflows/ci.yml

@@ -0,0 +1,150 @@
+{%- if cookiecutter.use_github_actions %}
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install {{ cookiecutter.python_version }}
+
+      - name: Install dependencies
+        run: uv sync --directory backend --dev
+
+      - name: Run ruff check
+        run: uv run --directory backend ruff check app tests cli
+
+      - name: Run ruff format check
+        run: uv run --directory backend ruff format app tests cli --check
+
+      - name: Run mypy
+        run: uv run --directory backend mypy app
+
+  test:
+    runs-on: ubuntu-latest
+{%- if cookiecutter.use_postgresql or cookiecutter.enable_redis %}
+    services:
+{%- if cookiecutter.use_postgresql %}
+      postgres:
+        image: postgres:16-alpine
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: test_db
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+{%- endif %}
+{%- if cookiecutter.enable_redis %}
+      redis:
+        image: redis:7-alpine
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+{%- endif %}
+{%- endif %}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install {{ cookiecutter.python_version }}
+
+      - name: Install dependencies
+        run: uv sync --directory backend --dev
+
+      - name: Run tests
+        run: uv run --directory backend pytest tests/ -v --cov=app --cov-report=xml
+        env:
+{%- if cookiecutter.use_postgresql %}
+          POSTGRES_HOST: localhost
+          POSTGRES_PORT: 5432
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: test_db
+{%- endif %}
+{%- if cookiecutter.enable_redis %}
+          REDIS_HOST: localhost
+          REDIS_PORT: 6379
+{%- endif %}
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./backend/coverage.xml
+          fail_ci_if_error: false
+
+  security:
+    name: Security Scan
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install {{ cookiecutter.python_version }}
+
+      - name: Install dependencies
+        run: uv sync --directory backend --dev
+
+      - name: Install pip-audit
+        run: uv pip install pip-audit
+
+      - name: Run pip-audit
+        run: uv run pip-audit --require-hashes=false --progress-spinner=off
+        working-directory: backend
+
+{%- if cookiecutter.enable_docker %}
+
+  docker:
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: ./backend
+          push: false
+          tags: {{ cookiecutter.project_slug }}:latest
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+{%- endif %}
+{%- else %}
+# GitHub Actions CI is disabled for this project
+{%- endif %}

fastapi_gen/template/{{cookiecutter.project_slug}}/.gitignore

@@ -0,0 +1,108 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+# Python lib directories (but not frontend src/lib)
+/lib/
+/lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.env.local
+.env.*.local
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pytype
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Local development
+*.db
+*.sqlite
+*.sqlite3
+
+# Logs
+*.log
+logs/
+
+# Docker
+.docker/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Project specific
+{%- if cookiecutter.use_sqlite %}
+{{ cookiecutter.project_slug }}.db
+{%- endif %}