fastapi-spawn 0.4.14__tar.gz → 0.4.16__tar.gz

{fastapi_spawn-0.4.14 → fastapi_spawn-0.4.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-spawn
-Version: 0.4.14
+Version: 0.4.16
 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
@@ -557,6 +557,9 @@ fastapi-spawn add prometheus   # Prometheus metrics
 fastapi-spawn add rbac             # Role-Based Access Control (@RequireRole decorator)
 fastapi-spawn add caching          # Redis API Response Caching (@cache decorator)
 fastapi-spawn add response-format  # Global formatted JSON response middleware
+fastapi-spawn add admin            # Internal CRUD Admin Dashboard (sqladmin)
+fastapi-spawn add pagination       # Automatic endpoint pagination logic
+fastapi-spawn add uploads          # File upload router (Multipart Form)
 ```
 
 *Example:*

{fastapi_spawn-0.4.14 → fastapi_spawn-0.4.16}/README.md

@@ -516,6 +516,9 @@ fastapi-spawn add prometheus   # Prometheus metrics
 fastapi-spawn add rbac             # Role-Based Access Control (@RequireRole decorator)
 fastapi-spawn add caching          # Redis API Response Caching (@cache decorator)
 fastapi-spawn add response-format  # Global formatted JSON response middleware
+fastapi-spawn add admin            # Internal CRUD Admin Dashboard (sqladmin)
+fastapi-spawn add pagination       # Automatic endpoint pagination logic
+fastapi-spawn add uploads          # File upload router (Multipart Form)
 ```
 
 *Example:*

{fastapi_spawn-0.4.14 → fastapi_spawn-0.4.16}/fastapi_spawn/__init__.py

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

{fastapi_spawn-0.4.14 → fastapi_spawn-0.4.16}/fastapi_spawn/cli.py

@@ -308,6 +308,9 @@ _ADDABLE_FEATURES = {
     "rbac":        "Role-Based Access Control (Permissions) boilerplate",
     "caching":     "Redis-based response caching (fastapi-cache2)",
     "response-format": "Global JSON response formatting middleware",
+    "admin":       "Auto-generated internal admin dashboard (sqladmin)",
+    "pagination":  "Automatic endpoint pagination (fastapi-pagination)",
+    "uploads":     "File upload router & handling",
     "docker":      "Dockerfile + docker-compose.yml",
     "ci":          "GitHub Actions CI/CD workflows",
     "helm":        "Helm chart (infra/helm/)",
@@ -382,9 +385,12 @@ def _feature_guidance(feature: str, _project_dir: Path) -> None:
         "sso-microsoft": ["1. Use 'fastapi-spawn new temp_app --extra sso-microsoft' and copy the resulting sso.py"],
         "seed":      ["Add dep: faker>=25.0.0", "Create db/seed.py (generate 100 mock users/posts)", "Run: uv run python db/seed.py"],
         "ocr":       ["Add deps: pymupdf>=1.24.0, pytesseract>=0.3.10", "Create app/core/ocr.py (PDF parsing pipeline)", "Install system deps: sudo apt install tesseract-ocr"],
-        "rbac":      ["Create app/core/permissions.py", "Add @router.get(..., dependencies=[Depends(RequireRole(['admin']))])"],
+        "rbac":      ["Create app/core/permissions.py and app/api/v1/permissions/router.py", "Add app.include_router(permissions.router) to main.py"],
         "caching":   ["Add dep: fastapi-cache2[redis]>=0.2.1", "Create app/core/cache.py", "Initialize cache in lifespan and use @cache(expire=60) on endpoints"],
         "response-format": ["Create app/middleware/response_format.py", "Add app.add_middleware(ResponseFormattingMiddleware) to main.py"],
+        "admin":     ["Add dep: sqladmin[full]>=0.16.1", "Create app/admin/setup.py", "Call setup_admin(app, engine) in main.py"],
+        "pagination":["Add dep: fastapi-pagination>=0.12.0", "Create app/api/v1/pagination/router.py", "Call add_pagination(app) in main.py"],
+        "uploads":   ["Create app/api/v1/uploads/router.py", "Include router in app/api/v1/router.py"],
         "docker":    ["Create Dockerfile (multi-stage, uv-based)", "Create docker-compose.yml with all selected services", "Create .dockerignore"],
         "ci":        ["Create .github/workflows/tests.yml (matrix: 3.10, 3.11, 3.12)", "Create .github/workflows/publish.yml (v* tags → PyPI)", "Add PYPI_API_TOKEN to GitHub repo secrets"],
         "helm":      ["Create infra/helm/Chart.yaml", "Create infra/helm/values.yaml (replicas, image, resources)", "Run: helm install my-release ./infra/helm"],

{fastapi_spawn-0.4.14 → fastapi_spawn-0.4.16}/fastapi_spawn/generator.py

@@ -238,6 +238,8 @@ class ProjectGenerator:
 
         if "rbac" in extras:
             self._render_to(core / "permissions.py", "app/core/permissions.py.j2")
+            (v1 / "permissions").mkdir(parents=True, exist_ok=True)
+            self._render_to(v1 / "permissions" / "router.py", "app/api/v1/permissions/router.py.j2")
 
         if "caching" in extras:
             self._render_to(core / "cache.py", "app/core/cache.py.j2")
@@ -247,6 +249,18 @@ class ProjectGenerator:
             middleware.mkdir(exist_ok=True)
             self._render_to(middleware / "response_format.py", "app/middleware/response_format.py.j2")
 
+        if "admin" in extras:
+            (pkg / "admin").mkdir(parents=True, exist_ok=True)
+            self._render_to(pkg / "admin" / "setup.py", "app/admin/setup.py.j2")
+
+        if "pagination" in extras:
+            (v1 / "pagination").mkdir(parents=True, exist_ok=True)
+            self._render_to(v1 / "pagination" / "router.py", "app/api/v1/pagination/router.py.j2")
+
+        if "uploads" in extras:
+            (v1 / "uploads").mkdir(parents=True, exist_ok=True)
+            self._render_to(v1 / "uploads" / "router.py", "app/api/v1/uploads/router.py.j2")
+
 
     def _generate_tasks(self, root: Path) -> None:
         """Root-level tasks/ directory."""

fastapi_spawn-0.4.16/fastapi_spawn/templates/app/admin/setup.py.j2

@@ -0,0 +1,30 @@
+from sqladmin import Admin, ModelView
+
+# Example User model admin view. 
+# Uncomment and replace with your actual model from app.models
+#
+# from app.models.user import User
+#
+# class UserAdmin(ModelView, model=User):
+#     column_list = [User.id, User.email]
+#     column_searchable_list = [User.email]
+#     column_sortable_list = [User.id]
+#     can_create = True
+#     can_edit = True
+#     can_delete = True
+#     can_view_details = True
+
+def setup_admin(app, engine):
+    """
+    Mounts the sqladmin dashboard at /admin.
+    Call this in your main.py:
+        from app.admin.setup import setup_admin
+        setup_admin(app, engine)
+    """
+    # Ensure authentication is added if exposing to production!
+    admin = Admin(app, engine, title="Admin Dashboard")
+    
+    # Register views here
+    # admin.add_view(UserAdmin)
+    
+    return admin

fastapi_spawn-0.4.16/fastapi_spawn/templates/app/api/v1/pagination/router.py.j2

@@ -0,0 +1,27 @@
+from fastapi import APIRouter
+from fastapi_pagination import Page, paginate
+from pydantic import BaseModel
+from typing import List
+
+router = APIRouter(
+    prefix="/items",
+    tags=["pagination"]
+)
+
+class ItemResponse(BaseModel):
+    id: int
+    name: str
+
+# Mock data
+fake_items = [{"id": i, "name": f"Item {i}"} for i in range(1, 101)]
+
+@router.get("/", response_model=Page[ItemResponse])
+async def get_items():
+    """
+    Returns a paginated list of items.
+    Usage: GET /api/v1/pagination/items?page=1&size=50
+    """
+    # If using SQLAlchemy:
+    # return paginate(db, select(Item))
+    
+    return paginate(fake_items)

fastapi_spawn-0.4.16/fastapi_spawn/templates/app/api/v1/permissions/router.py.j2

@@ -0,0 +1,23 @@
+from fastapi import APIRouter, Depends
+from app.core.permissions import RequireRole, RequirePermission
+
+# This router restricts access to all its endpoints using the RequireRole dependency
+router = APIRouter(
+    prefix="/admin",
+    tags=["admin", "rbac"],
+    dependencies=[Depends(RequireRole(["admin"]))]
+)
+
+@router.get("/dashboard")
+async def get_admin_dashboard():
+    """
+    This endpoint is only accessible to users with the 'admin' role.
+    """
+    return {"message": "Welcome to the secure admin dashboard!"}
+
+@router.get("/settings", dependencies=[Depends(RequirePermission("write:settings"))])
+async def update_admin_settings():
+    """
+    This endpoint requires both the 'admin' role (from the router) AND the 'write:settings' permission.
+    """
+    return {"message": "Admin settings successfully updated."}

fastapi_spawn-0.4.16/fastapi_spawn/templates/app/api/v1/uploads/router.py.j2

@@ -0,0 +1,43 @@
+from fastapi import APIRouter, UploadFile, File, HTTPException
+import shutil
+import os
+import uuid
+
+router = APIRouter(
+    prefix="/uploads",
+    tags=["uploads"]
+)
+
+# Maximum file size (5MB)
+MAX_FILE_SIZE = 5 * 1024 * 1024
+
+@router.post("/")
+async def upload_file(file: UploadFile = File(...)):
+    """
+    Upload a single file. Saves it locally in a 'media/' directory.
+    If you configured S3 or GCS, replace the local save logic with your storage client.
+    """
+    if file.size and file.size > MAX_FILE_SIZE:
+        raise HTTPException(status_code=400, detail="File too large. Maximum size is 5MB.")
+    
+    # Ensure secure filename (prevent directory traversal)
+    ext = os.path.splitext(file.filename)[1] if file.filename else ""
+    safe_filename = f"{uuid.uuid4().hex}{ext}"
+    
+    # Save locally as an example
+    upload_dir = "media"
+    os.makedirs(upload_dir, exist_ok=True)
+    file_path = os.path.join(upload_dir, safe_filename)
+    
+    try:
+        with open(file_path, "wb") as buffer:
+            shutil.copyfileobj(file.file, buffer)
+    except Exception as e:
+        raise HTTPException(status_code=500, detail=f"Could not save file: {e}")
+        
+    return {
+        "filename": file.filename, 
+        "saved_as": safe_filename,
+        "size": file.size,
+        "url": f"/{file_path}"
+    }

{fastapi_spawn-0.4.14 → fastapi_spawn-0.4.16}/fastapi_spawn/templates/base/pyproject.toml.j2

@@ -177,6 +177,12 @@ dependencies = [
 {% if "caching" in extras %}
     "fastapi-cache2[redis]>=0.2.1",
 {% endif %}
+{% if "admin" in extras %}
+    "sqladmin[full]>=0.16.1",
+{% endif %}
+{% if "pagination" in extras %}
+    "fastapi-pagination>=0.12.0",
+{% endif %}
 {% if "meilisearch" in extras %}
     "meilisearch>=0.30.0",
 {% endif %}

{fastapi_spawn-0.4.14 → fastapi_spawn-0.4.16}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fastapi-spawn"
-version = "0.4.14"
+version = "0.4.16"
 description = "A powerful CLI tool to scaffold production-ready FastAPI projects with flexible database, auth, broker, and deployment options."
 readme = "README.md"
 license = { text = "MIT" }