fastapi-forge-cli 0.1.0__py3-none-any.whl

fastapi_forge/templates/without_rbac/app/db/schemas/common.py

@@ -0,0 +1,70 @@
+import uuid
+from datetime import datetime, timezone
+
+from sqlalchemy import Boolean, DateTime, Text, func
+from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.orm import Mapped, mapped_column
+
+
+def utcnow():
+    return datetime.now(timezone.utc)
+
+
+class UUIDMixin:
+    """Provides a UUID primary key."""
+
+    id: Mapped[uuid.UUID] = mapped_column(
+        UUID(as_uuid=True),
+        primary_key=True,
+        default=uuid.uuid4,
+        index=True,
+    )
+
+
+class TimestampMixin:
+    """Adds created_at / updated_at columns with automatic server defaults."""
+
+    created_at: Mapped[datetime] = mapped_column(
+        DateTime(timezone=True),
+        server_default=func.now(),
+        nullable=False,
+    )
+    updated_at: Mapped[datetime] = mapped_column(
+        DateTime(timezone=True),
+        server_default=func.now(),
+        onupdate=func.now(),
+        nullable=False,
+    )
+
+
+class SoftDeleteMixin:
+    """
+    Provides soft-delete support.
+    - is_deleted=True  → soft-deleted (row hidden from normal queries)
+    - deleted_at       → timestamp of soft-deletion
+    Call .hard_delete() on the session to permanently remove the row.
+    """
+
+    is_deleted: Mapped[bool] = mapped_column(
+        Boolean, default=False, nullable=False, index=True
+    )
+    deleted_at: Mapped[datetime | None] = mapped_column(
+        DateTime(timezone=True), nullable=True
+    )
+    deletion_note: Mapped[str | None] = mapped_column(Text, nullable=True)
+
+    def soft_delete(self, note: str | None = None) -> None:
+        self.is_deleted = True
+        self.deleted_at = utcnow()
+        self.deletion_note = note
+
+    def restore(self) -> None:
+        self.is_deleted = False
+        self.deleted_at = None
+        self.deletion_note = None
+
+
+class BaseModelMixin(UUIDMixin, TimestampMixin, SoftDeleteMixin):
+    """Convenience mixin that combines UUID PK, timestamps, and soft-delete."""
+
+    pass

fastapi_forge/templates/without_rbac/app/db/schemas/names.py

@@ -0,0 +1,5 @@
+APP_SCHEMA = "app"
+AUTH_SCHEMA = "auth"
+
+ALL_SCHEMAS = (AUTH_SCHEMA, APP_SCHEMA)
+

fastapi_forge/templates/without_rbac/app/db/session.py

@@ -0,0 +1,86 @@
+from sqlalchemy import create_engine, text
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
+from sqlalchemy.orm import Session, sessionmaker
+
+from app.core.config import settings
+from app.core.logging import get_logger
+from app.db.base import Base
+from app.db.models import *
+from app.db.schemas.names import ALL_SCHEMAS
+
+logger = get_logger(__name__)
+
+async_engine = create_async_engine(
+    settings.postgres_async_url,
+    echo=settings.database_debug,
+    pool_size=settings.database_pool_size,
+    max_overflow=settings.database_max_overflow,
+    pool_timeout=settings.database_pool_timeout,
+    pool_pre_ping=True,
+)
+
+AsyncSessionLocal: async_sessionmaker[AsyncSession] = async_sessionmaker(
+    bind=async_engine,
+    class_=AsyncSession,
+    autoflush=False,
+    autocommit=False,
+    expire_on_commit=False,
+)
+
+sync_engine = create_engine(
+    settings.postgres_url,
+    echo=settings.database_debug,
+    pool_size=settings.database_pool_size,
+    max_overflow=settings.database_max_overflow,
+    pool_timeout=settings.database_pool_timeout,
+    pool_pre_ping=True,
+)
+
+SyncSessionLocal: sessionmaker[Session] = sessionmaker(
+    bind=sync_engine,
+    class_=Session,
+    autoflush=False,
+    autocommit=False,
+    expire_on_commit=False,
+)
+
+engine = sync_engine
+SessionLocal = SyncSessionLocal
+
+
+def create_db_and_tables() -> None:
+    with sync_engine.begin() as connection:
+        for schema in ALL_SCHEMAS:
+            connection.execute(text(f"CREATE SCHEMA IF NOT EXISTS {schema}"))
+        Base.metadata.create_all(bind=connection)
+
+
+def get_session():
+    db = SessionLocal()
+    try:
+        yield db
+    finally:
+        db.close()
+
+
+async def check_db_health() -> dict:
+    try:
+        async with AsyncSessionLocal() as session:
+            await session.execute(text("SELECT 1"))
+        return {"status": "healthy", "database": "connected"}
+    except Exception as exc:
+        logger.error("Database health check failed", error=str(exc))
+        return {"status": "unhealthy", "database": "disconnected", "error": str(exc)}
+
+
+async def connect_db() -> None:
+    result = await check_db_health()
+    if result["status"] != "healthy":
+        raise RuntimeError("Database connection failed on startup")
+    logger.info("Database connected successfully")
+
+
+async def disconnect_db() -> None:
+    await async_engine.dispose()
+    sync_engine.dispose()
+    logger.info("Database connections closed")

fastapi_forge/templates/without_rbac/app/helper/__init__.py

@@ -0,0 +1 @@
+

fastapi_forge/templates/without_rbac/app/helper/pagination_helper.py

@@ -0,0 +1,44 @@
+from fastapi import Query
+
+from app.core.config import settings
+
+
+def get_pagination_offset(page: int, page_size: int) -> int:
+    return (page - 1) * page_size
+
+
+def apply_pagination(query, page: int, page_size: int, enabled: bool = True):
+    if not enabled:
+        return query
+    return query.offset(get_pagination_offset(page, page_size)).limit(page_size)
+
+
+class PaginationParams:
+    def __init__(
+        self,
+        page: int = Query(default=1, ge=1),
+        page_size: int = Query(
+            default=settings.default_page_size,
+            ge=1,
+            le=settings.max_page_size,
+            alias="pageSize",
+        ),
+        pagination: bool = Query(default=True),
+        search: str | None = Query(default=None),
+        sort_by: str | None = Query(default=None, alias="sortBy"),
+        sort_order: str | None = Query(default="asc", alias="sortOrder"),
+    ):
+        self.page = page
+        self.page_size = page_size
+        self.pagination = pagination
+        self.search = search
+        self.sort_by = sort_by
+        self.sort_order = sort_order
+
+    @property
+    def offset(self) -> int:
+        return get_pagination_offset(self.page, self.page_size)
+
+    @property
+    def limit(self) -> int:
+        return self.page_size

fastapi_forge/templates/without_rbac/app/helper/search.py

@@ -0,0 +1,51 @@
+from sqlalchemy import Text, and_, or_
+from sqlalchemy.sql.sqltypes import String
+
+
+DEFAULT_EXCLUDED_FIELDS = {
+    "hashed_password",
+    "request_sql",
+    "request_params_json",
+    "response_json",
+    "raw_response_json",
+    "coverages_json",
+}
+
+
+def text_search_filter(model, search: str | None, columns=None, name_columns=None):
+    query = (search or "").strip()
+    if not query:
+        return None
+
+    fields = columns or [
+        column
+        for column in model.__table__.columns
+        if isinstance(column.type, (String, Text))
+        and column.key not in DEFAULT_EXCLUDED_FIELDS
+    ]
+    expressions = []
+    if fields:
+        like = f"%{query}%"
+        expressions.extend(field.ilike(like) for field in fields)
+
+    if name_columns:
+        first_name_column, last_name_column = name_columns
+        parts = query.split(maxsplit=1)
+        if len(parts) == 2:
+            expressions.extend(
+                [
+                    and_(
+                        first_name_column.ilike(f"%{parts[0]}%"),
+                        last_name_column.ilike(f"%{parts[1]}%"),
+                    ),
+                    and_(
+                        first_name_column.ilike(f"%{parts[1]}%"),
+                        last_name_column.ilike(f"%{parts[0]}%"),
+                    ),
+                ]
+            )
+
+    if not expressions:
+        return None
+
+    return or_(*expressions)

fastapi_forge/templates/without_rbac/app/helper/sorting.py

@@ -0,0 +1,77 @@
+import re
+from typing import Any
+
+from fastapi import HTTPException
+from sqlalchemy import inspect
+
+
+def to_snake_case(value: str) -> str:
+    value = value.strip()
+    value = re.sub(r"(.)([A-Z][a-z]+)", r"\1_\2", value)
+    return re.sub(r"([a-z0-9])([A-Z])", r"\1_\2", value).lower()
+
+
+def sort_expressions(
+    model: Any,
+    sort_by: str | None,
+    sort_order: str | None,
+    default_order: tuple[Any, ...] = (),
+) -> tuple[Any, ...]:
+    if not sort_by:
+        return default_order
+
+    field = to_snake_case(sort_by)
+    columns = inspect(model).columns
+    if field not in columns:
+        raise HTTPException(status_code=422, detail=f"Invalid sortBy '{sort_by}'")
+
+    column = columns[field]
+    direction = _normalize_sort_order(sort_order)
+    return (column.desc() if direction == "desc" else column.asc(),)
+
+
+def sort_items(
+    items: list[Any], sort_by: str | None, sort_order: str | None
+) -> list[Any]:
+    if not sort_by:
+        return items
+
+    field = to_snake_case(sort_by)
+    direction = _normalize_sort_order(sort_order)
+
+    if items:
+        first = items[0]
+        if isinstance(first, dict):
+            if sort_by not in first and field not in first:
+                raise HTTPException(
+                    status_code=422,
+                    detail=f"Invalid sortBy '{sort_by}'",
+                )
+        elif not hasattr(first, field):
+            raise HTTPException(status_code=422, detail=f"Invalid sortBy '{sort_by}'")
+
+    return sorted(
+        items,
+        key=lambda item: _item_value(item, sort_by, field),
+        reverse=direction == "desc",
+    )
+
+
+def _normalize_sort_order(sort_order: str | None) -> str:
+    value = (sort_order or "asc").lower()
+    if value not in {"asc", "desc"}:
+        raise HTTPException(
+            status_code=422,
+            detail="sortOrder must be either 'asc' or 'desc'",
+        )
+    return value
+
+
+def _item_value(item, sort_by: str, field: str):
+    if isinstance(item, dict):
+        value = item.get(sort_by)
+        if value is None:
+            value = item.get(field)
+    else:
+        value = getattr(item, field, None)
+    return (value is None, value)

fastapi_forge/templates/without_rbac/app/main.py

@@ -0,0 +1,66 @@
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI, Request
+from fastapi.responses import JSONResponse
+from slowapi.errors import RateLimitExceeded
+
+from app.api.v1.api import register_api_routes
+from app.core.config import settings
+from app.core.exceptions import register_exception_handlers
+from app.core.logging import configure_logging, get_logger
+from app.core.middleware import limiter, register_middleware
+from app.core.responses import error_response
+from app.db.session import connect_db, disconnect_db
+
+configure_logging()
+logger = get_logger(__name__)
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    logger.info("Starting application", name=settings.APP_NAME, env=settings.APP_ENV)
+    await connect_db()
+    yield
+    await disconnect_db()
+    logger.info("Application shutdown complete")
+
+
+app = FastAPI(
+    title=settings.APP_NAME,
+    version=settings.APP_VERSION,
+    description="FastAPI boilerplate with JWT authentication, superuser authorization, and audit logs.",
+    docs_url="/docs" if not settings.is_production else None,
+    redoc_url="/redoc" if not settings.is_production else None,
+    openapi_url="/openapi.json" if not settings.is_production else None,
+    lifespan=lifespan,
+    swagger_ui_parameters={"docExpansion": "none"},
+)
+app.state.limiter = limiter
+
+
+@app.exception_handler(RateLimitExceeded)
+async def rate_limit_handler(request: Request, exc: RateLimitExceeded) -> JSONResponse:
+    return JSONResponse(
+        status_code=429,
+        content=error_response(
+            message="Too many requests. Please slow down.",
+            error_code="RATE_LIMIT_EXCEEDED",
+            request_id=getattr(request.state, "request_id", None),
+        ).model_dump(by_alias=True),
+    )
+
+
+register_middleware(app)
+register_exception_handlers(app)
+
+
+@app.get("/", tags=["Root"])
+async def root():
+    return {
+        "message": f"Welcome to {settings.APP_NAME}",
+        "version": settings.APP_VERSION,
+        "docs": None if settings.is_production else "/docs",
+    }
+
+
+register_api_routes(app)

fastapi_forge/templates/without_rbac/app/repositories/__init__.py

@@ -0,0 +1 @@
+