forgeapi 0.1.0__py3-none-any.whl

fastapi_forge/templates/base/.github/workflows/ci.yml.jinja

@@ -0,0 +1,155 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    {% if database_type != 'none' %}
+    services:
+      {% if database_type == 'postgres' %}
+      postgres:
+        image: postgres:15-alpine
+        env:
+          POSTGRES_USER: test
+          POSTGRES_PASSWORD: test
+          POSTGRES_DB: test_db
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+      {% elif database_type == 'mysql' %}
+      mysql:
+        image: mysql:8.0
+        env:
+          MYSQL_ROOT_PASSWORD: test
+          MYSQL_DATABASE: test_db
+          MYSQL_USER: test
+          MYSQL_PASSWORD: test
+        ports:
+          - 3306:3306
+        options: >-
+          --health-cmd "mysqladmin ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+      {% endif %}
+      {% if use_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: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "{{ python_version }}"
+
+      {% if use_uv %}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run linting
+        run: uv run ruff check .
+
+      - name: Run type checking
+        run: uv run mypy app
+
+      - name: Run tests
+        run: uv run pytest -v --cov=app --cov-report=xml
+        env:
+          {% if database_type == 'postgres' %}
+          DATABASE_URL: "postgresql+asyncpg://test:test@localhost:5432/test_db"
+          {% elif database_type == 'mysql' %}
+          DATABASE_URL: "mysql+asyncmy://test:test@localhost:3306/test_db"
+          {% elif database_type == 'sqlite' %}
+          DATABASE_URL: "sqlite+aiosqlite:///./test.db"
+          {% endif %}
+          {% if use_redis %}
+          REDIS_URL: "redis://localhost:6379/0"
+          {% endif %}
+      {% elif use_poetry %}
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+
+      - name: Install dependencies
+        run: poetry install --with dev
+
+      - name: Run linting
+        run: poetry run ruff check .
+
+      - name: Run type checking
+        run: poetry run mypy app
+
+      - name: Run tests
+        run: poetry run pytest -v --cov=app --cov-report=xml
+        env:
+          {% if database_type == 'postgres' %}
+          DATABASE_URL: "postgresql+asyncpg://test:test@localhost:5432/test_db"
+          {% elif database_type == 'mysql' %}
+          DATABASE_URL: "mysql+asyncmy://test:test@localhost:3306/test_db"
+          {% elif database_type == 'sqlite' %}
+          DATABASE_URL: "sqlite+aiosqlite:///./test.db"
+          {% endif %}
+          {% if use_redis %}
+          REDIS_URL: "redis://localhost:6379/0"
+          {% endif %}
+      {% else %}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r requirements-dev.txt
+
+      - name: Run linting
+        run: ruff check .
+
+      - name: Run type checking
+        run: mypy app
+
+      - name: Run tests
+        run: pytest -v --cov=app --cov-report=xml
+        env:
+          {% if database_type == 'postgres' %}
+          DATABASE_URL: "postgresql+asyncpg://test:test@localhost:5432/test_db"
+          {% elif database_type == 'mysql' %}
+          DATABASE_URL: "mysql+asyncmy://test:test@localhost:3306/test_db"
+          {% elif database_type == 'sqlite' %}
+          DATABASE_URL: "sqlite+aiosqlite:///./test.db"
+          {% endif %}
+          {% if use_redis %}
+          REDIS_URL: "redis://localhost:6379/0"
+          {% endif %}
+      {% endif %}
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false

fastapi_forge/templates/base/.gitignore.jinja

@@ -0,0 +1,68 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.vscode/
+.idea/
+
+# macOS
+.DS_Store
+
+# uv
+uv.lock
+
+# Ruff
+.ruff_cache/
+
+# mypy
+.mypy_cache/

fastapi_forge/templates/base/Dockerfile.jinja

@@ -0,0 +1,69 @@
+FROM python:{{ python_version }}-slim
+
+WORKDIR /app
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    gcc \
+    && rm -rf /var/lib/apt/lists/*
+
+{% if use_uv %}
+# Install uv
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
+
+# Copy project files
+COPY pyproject.toml ./
+COPY app ./app
+{% if use_alembic %}
+COPY alembic ./alembic
+COPY alembic.ini ./
+{% endif %}
+COPY config.yaml ./
+
+# Install dependencies
+RUN uv sync --frozen --no-dev
+
+# Set Python path
+ENV PYTHONPATH=/app
+ENV PATH="/app/.venv/bin:$PATH"
+
+{% elif use_poetry %}
+# Install Poetry
+RUN pip install poetry
+
+# Copy project files
+COPY pyproject.toml poetry.lock* ./
+COPY app ./app
+{% if use_alembic %}
+COPY alembic ./alembic
+COPY alembic.ini ./
+{% endif %}
+COPY config.yaml ./
+
+# Install dependencies
+RUN poetry config virtualenvs.create false \
+    && poetry install --no-interaction --no-ansi --without dev
+
+# Set Python path
+ENV PYTHONPATH=/app
+
+{% else %}
+# Copy requirements
+COPY requirements.txt ./
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Copy project files
+COPY app ./app
+{% if use_alembic %}
+COPY alembic ./alembic
+COPY alembic.ini ./
+{% endif %}
+COPY config.yaml ./
+
+# Set Python path
+ENV PYTHONPATH=/app
+{% endif %}
+
+EXPOSE 8000
+
+CMD ["python", "-m", "app.main"]

fastapi_forge/templates/base/README.md.jinja

@@ -0,0 +1,141 @@
+# {{ project_name }}
+
+{{ project_description }}
+
+## 🚀 Quick Start
+
+### Prerequisites
+
+- Python {{ python_version }}+
+{% if use_uv %}
+- [uv](https://docs.astral.sh/uv/) (recommended)
+{% elif use_poetry %}
+- [Poetry](https://python-poetry.org/)
+{% endif %}
+{% if use_docker %}
+- Docker & Docker Compose
+{% endif %}
+
+### Installation
+
+{% if use_uv %}
+```bash
+# Install dependencies
+uv sync
+
+# Activate virtual environment
+source .venv/bin/activate
+```
+{% elif use_poetry %}
+```bash
+# Install dependencies
+poetry install
+
+# Activate virtual environment
+poetry shell
+```
+{% else %}
+```bash
+# Create virtual environment
+python -m venv .venv
+source .venv/bin/activate
+
+# Install dependencies
+pip install -r requirements.txt
+```
+{% endif %}
+
+{% if use_docker_compose %}
+### Running with Docker
+
+```bash
+# Start all services
+docker-compose up -d
+
+# View logs
+docker-compose logs -f
+```
+{% endif %}
+
+### Running Locally
+
+{% if use_alembic %}
+```bash
+# Run database migrations
+{% if use_uv %}
+uv run alembic upgrade head
+{% elif use_poetry %}
+poetry run alembic upgrade head
+{% else %}
+alembic upgrade head
+{% endif %}
+```
+{% endif %}
+
+```bash
+# Start the development server
+{% if use_uv %}
+uv run python -m app.main
+{% elif use_poetry %}
+poetry run python -m app.main
+{% else %}
+python -m app.main
+{% endif %}
+```
+
+The API will be available at http://localhost:8000
+
+- 📚 API Documentation: http://localhost:8000/docs
+- 📖 ReDoc: http://localhost:8000/redoc
+
+## 📁 Project Structure
+
+```
+{{ project_name }}/
+├── app/
+│   ├── api/           # API routes
+│   ├── config/        # Configuration
+│   ├── core/          # Core utilities
+{% if use_database %}
+│   ├── daos/          # Data Access Objects
+{% endif %}
+│   ├── exceptions/    # Exception handlers
+{% if use_database %}
+│   ├── models/        # SQLAlchemy models
+{% endif %}
+│   ├── schemas/       # Pydantic schemas
+│   ├── services/      # Business logic
+│   └── utils/         # Utilities
+{% if use_alembic %}
+├── alembic/           # Database migrations
+{% endif %}
+├── tests/             # Test suite
+{% if use_docker %}
+├── Dockerfile
+{% endif %}
+{% if use_docker_compose %}
+├── docker-compose.yml
+{% endif %}
+├── pyproject.toml
+└── README.md
+```
+
+## 🧪 Testing
+
+```bash
+{% if use_uv %}
+uv run pytest
+{% elif use_poetry %}
+poetry run pytest
+{% else %}
+pytest
+{% endif %}
+```
+
+## 📄 License
+
+This project is licensed under the MIT License.
+
+---
+
+Generated with ❤️ by [FastAPI-Forge](https://github.com/zachary/forgeapi)

fastapi_forge/templates/base/alembic/README.md.jinja

@@ -0,0 +1,43 @@
+# Database Migrations
+
+This directory contains Alembic database migration scripts.
+
+## Commands
+
+```bash
+# Create a new migration
+{% if use_uv %}
+uv run alembic revision --autogenerate -m "description"
+{% elif use_poetry %}
+poetry run alembic revision --autogenerate -m "description"
+{% else %}
+alembic revision --autogenerate -m "description"
+{% endif %}
+
+# Apply migrations
+{% if use_uv %}
+uv run alembic upgrade head
+{% elif use_poetry %}
+poetry run alembic upgrade head
+{% else %}
+alembic upgrade head
+{% endif %}
+
+# Rollback one migration
+{% if use_uv %}
+uv run alembic downgrade -1
+{% elif use_poetry %}
+poetry run alembic downgrade -1
+{% else %}
+alembic downgrade -1
+{% endif %}
+
+# Show migration history
+{% if use_uv %}
+uv run alembic history
+{% elif use_poetry %}
+poetry run alembic history
+{% else %}
+alembic history
+{% endif %}
+```

fastapi_forge/templates/base/alembic/env.py.jinja

@@ -0,0 +1,93 @@
+"""
+Alembic Environment Configuration
+
+This module configures Alembic for database migrations.
+"""
+
+import asyncio
+from logging.config import fileConfig
+
+from sqlalchemy import pool
+from sqlalchemy.engine import Connection
+from sqlalchemy.ext.asyncio import async_engine_from_config
+
+from alembic import context
+
+from app.core.config import get_config
+from app.models.base import Base
+
+# Import all models here to ensure they are registered with SQLAlchemy
+# from app.models.user import User
+
+# Alembic Config object
+config = context.config
+
+# Interpret the config file for Python logging
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# Add your model's MetaData object here for 'autogenerate' support
+target_metadata = Base.metadata
+
+
+def get_database_url() -> str:
+    """Get the database URL from application config."""
+    app_config = get_config()
+    return app_config.db.database_url
+
+
+def run_migrations_offline() -> None:
+    """
+    Run migrations in 'offline' mode.
+
+    This configures the context with just a URL and not an Engine,
+    though an Engine is acceptable here as well.
+    """
+    url = get_database_url()
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def do_run_migrations(connection: Connection) -> None:
+    """Run migrations with the given connection."""
+    context.configure(connection=connection, target_metadata=target_metadata)
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+async def run_async_migrations() -> None:
+    """
+    Run migrations in 'online' mode with async engine.
+    """
+    configuration = config.get_section(config.config_ini_section)
+    configuration["sqlalchemy.url"] = get_database_url()
+
+    connectable = async_engine_from_config(
+        configuration,
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    async with connectable.connect() as connection:
+        await connection.run_sync(do_run_migrations)
+
+    await connectable.dispose()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode."""
+    asyncio.run(run_async_migrations())
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

fastapi_forge/templates/base/alembic/script.py.mako.jinja

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

fastapi_forge/templates/base/alembic/versions/.gitkeep.jinja

@@ -0,0 +1 @@
+# Migration versions directory

fastapi_forge/templates/base/alembic.ini.jinja

@@ -0,0 +1,70 @@
+# Alembic Configuration
+
+A generic, single database configuration.
+
+[alembic]
+# Path to migration scripts
+script_location = alembic
+
+# Template used to generate migration file names
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present
+prepend_sys_path = .
+
+# Timezone to use when rendering the date within the migration file
+# timezone =
+
+# Max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# Set to 'true' to run the environment during the 'revision' command
+# revision_environment = false
+
+# Set to 'true' to allow .pyc and .pyo files without a source .py file
+# sourceless = false
+
+# Version path separator
+version_path_separator = os
+
+# Output encoding used when revision files are written from script.py.mako
+# output_encoding = utf-8
+
+# SQLAlchemy URL - This is set dynamically in env.py
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+[post_write_hooks]
+
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

fastapi_forge/templates/base/app/__init__.py.jinja

@@ -0,0 +1,5 @@
+"""
+{{ project_name }} - {{ project_description }}
+"""
+
+__version__ = "0.1.0"

fastapi_forge/templates/base/app/api/__init__.py.jinja

@@ -0,0 +1,3 @@
+"""
+API Routes Module
+"""