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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-spawn
-Version: 0.4.12
+Version: 0.4.14
 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
@@ -100,6 +100,30 @@ fastapi-spawn add alembic
 fastapi-spawn add sentry
 ```
 
+```
+
+---
+
+## 🆘 Built-in Help & Auto-Suggestions
+
+`fastapi-spawn` comes with an integrated global help menu and intelligent typo correction:
+
+```bash
+# Display the interactive global help menu
+fastapi-spawn help
+
+# Or use the standard flag
+fastapi-spawn --help
+```
+
+### Auto-Typo Correction (Did you mean?)
+If you accidentally misspell a command, the CLI will catch it and suggest the right one automatically to save you time.
+```bash
+$ fastapi-spawn nw my_app
+
+Error: No such command 'nw'. Did you mean 'new'?
+```
+
 ---
 
 ## Generated Project Structure
@@ -528,6 +552,11 @@ fastapi-spawn add seed         # Faker database seeding script (Users, Posts, Co
 fastapi-spawn add resend       # Resend modern email client
 fastapi-spawn add sentry       # Sentry APM integration
 fastapi-spawn add prometheus   # Prometheus metrics
+
+# Advanced API Features
+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
 ```
 
 *Example:*

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

@@ -59,6 +59,30 @@ fastapi-spawn add alembic
 fastapi-spawn add sentry
 ```
 
+```
+
+---
+
+## 🆘 Built-in Help & Auto-Suggestions
+
+`fastapi-spawn` comes with an integrated global help menu and intelligent typo correction:
+
+```bash
+# Display the interactive global help menu
+fastapi-spawn help
+
+# Or use the standard flag
+fastapi-spawn --help
+```
+
+### Auto-Typo Correction (Did you mean?)
+If you accidentally misspell a command, the CLI will catch it and suggest the right one automatically to save you time.
+```bash
+$ fastapi-spawn nw my_app
+
+Error: No such command 'nw'. Did you mean 'new'?
+```
+
 ---
 
 ## Generated Project Structure
@@ -487,6 +511,11 @@ fastapi-spawn add seed         # Faker database seeding script (Users, Posts, Co
 fastapi-spawn add resend       # Resend modern email client
 fastapi-spawn add sentry       # Sentry APM integration
 fastapi-spawn add prometheus   # Prometheus metrics
+
+# Advanced API Features
+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
 ```
 
 *Example:*

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

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

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

@@ -305,6 +305,9 @@ _ADDABLE_FEATURES = {
     "sso-microsoft": "FastAPI SSO (Microsoft only)",
     "seed":        "Database seeding script using Faker",
     "ocr":         "PDF & OCR data pipeline (PyMuPDF / Tesseract)",
+    "rbac":        "Role-Based Access Control (Permissions) boilerplate",
+    "caching":     "Redis-based response caching (fastapi-cache2)",
+    "response-format": "Global JSON response formatting middleware",
     "docker":      "Dockerfile + docker-compose.yml",
     "ci":          "GitHub Actions CI/CD workflows",
     "helm":        "Helm chart (infra/helm/)",
@@ -379,6 +382,9 @@ 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']))])"],
+        "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"],
         "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.12 → fastapi_spawn-0.4.14}/fastapi_spawn/generator.py

@@ -236,6 +236,17 @@ class ProjectGenerator:
         if "meilisearch" in extras:
             self._render_to(core / "search.py", "app/core/search.py.j2")
 
+        if "rbac" in extras:
+            self._render_to(core / "permissions.py", "app/core/permissions.py.j2")
+
+        if "caching" in extras:
+            self._render_to(core / "cache.py", "app/core/cache.py.j2")
+
+        if "response-format" in extras:
+            middleware = pkg / "middleware"
+            middleware.mkdir(exist_ok=True)
+            self._render_to(middleware / "response_format.py", "app/middleware/response_format.py.j2")
+
 
     def _generate_tasks(self, root: Path) -> None:
         """Root-level tasks/ directory."""

fastapi_spawn-0.4.14/fastapi_spawn/templates/app/core/cache.py.j2

@@ -0,0 +1,32 @@
+from fastapi_cache import FastAPICache
+from fastapi_cache.backends.redis import RedisBackend
+from redis import asyncio as aioredis
+from app.core.config import settings
+import logging
+
+logger = logging.getLogger(__name__)
+
+async def init_cache():
+    """
+    Initialize Redis caching backend for fastapi-cache2.
+    Call this function in your application startup event (e.g., lifespan in main.py).
+    """
+    try:
+        redis_url = getattr(settings, "REDIS_URL", "redis://localhost:6379/0")
+        redis = aioredis.from_url(redis_url, encoding="utf8", decode_responses=True)
+        FastAPICache.init(RedisBackend(redis), prefix="fastapi-cache")
+        logger.info("Successfully initialized FastAPI Redis Cache.")
+    except Exception as e:
+        logger.error(f"Failed to initialize cache: {e}")
+
+# --- Usage Example ---
+#
+# from fastapi_cache.decorator import cache
+# from fastapi import APIRouter
+#
+# router = APIRouter()
+#
+# @router.get("/heavy-data")
+# @cache(expire=60)  # Caches the response for 60 seconds (TTL)
+# async def get_heavy_data():
+#     return {"data": "This response is cached!"}

fastapi_spawn-0.4.14/fastapi_spawn/templates/app/core/permissions.py.j2

@@ -0,0 +1,52 @@
+from typing import List, Callable
+from fastapi import HTTPException, Security, status
+from pydantic import BaseModel
+
+# Mock User model for demonstration. Replace with your actual User model from app.models
+class User(BaseModel):
+    id: str
+    email: str
+    role: str
+
+def get_current_user() -> User:
+    """
+    Mock dependency. Replace this with your actual JWT/Auth dependency.
+    """
+    return User(id="123", email="user@example.com", role="user")
+
+class RequireRole:
+    """
+    RBAC Dependency.
+    Usage:
+        @router.get("/admin", dependencies=[Depends(RequireRole(["admin", "superadmin"]))])
+    """
+    def __init__(self, allowed_roles: List[str]):
+        self.allowed_roles = allowed_roles
+
+    def __call__(self, current_user: User = Security(get_current_user)) -> User:
+        if current_user.role not in self.allowed_roles:
+            raise HTTPException(
+                status_code=status.HTTP_403_FORBIDDEN,
+                detail="You do not have the required role to access this resource."
+            )
+        return current_user
+
+class RequirePermission:
+    """
+    Fine-grained access control dependency.
+    Usage:
+        @router.get("/data", dependencies=[Depends(RequirePermission("read:data"))])
+    """
+    def __init__(self, required_permission: str):
+        self.required_permission = required_permission
+
+    def __call__(self, current_user: User = Security(get_current_user)) -> User:
+        # Replace this logic with your actual permission checking (e.g. query DB for user permissions)
+        user_permissions = ["read:data", "write:data"] if current_user.role == "admin" else ["read:data"]
+        
+        if self.required_permission not in user_permissions:
+            raise HTTPException(
+                status_code=status.HTTP_403_FORBIDDEN,
+                detail=f"Missing required permission: {self.required_permission}"
+            )
+        return current_user

fastapi_spawn-0.4.14/fastapi_spawn/templates/app/middleware/response_format.py.j2

@@ -0,0 +1,64 @@
+import json
+from starlette.middleware.base import BaseHTTPMiddleware
+from fastapi import Request
+from starlette.responses import JSONResponse
+
+class ResponseFormattingMiddleware(BaseHTTPMiddleware):
+    """
+    Intercepts all JSON responses and formats them into a standard structure:
+    {
+        "status": "success" | "error",
+        "message": "...",
+        "data": { ... },
+        "error": { ... }
+    }
+    """
+    async def dispatch(self, request: Request, call_next):
+        response = await call_next(request)
+        
+        # Only process JSON responses
+        if response.headers.get("content-type") == "application/json":
+            body = b""
+            async for chunk in response.body_iterator:
+                body += chunk
+            
+            try:
+                data = json.loads(body.decode("utf-8"))
+            except json.JSONDecodeError:
+                data = body.decode("utf-8")
+
+            is_success = response.status_code < 400
+            
+            # Avoid wrapping if already formatted (e.g. custom exceptions might do this)
+            if isinstance(data, dict) and "status" in data and "data" in data and "error" in data:
+                return JSONResponse(
+                    content=data, 
+                    status_code=response.status_code, 
+                    headers=dict(response.headers)
+                )
+
+            # Determine appropriate message
+            if is_success:
+                message = "Request successful"
+            else:
+                # FastAPI default validation errors are in `detail`
+                message = data.get("detail", "An error occurred") if isinstance(data, dict) else "An error occurred"
+
+            formatted_response = {
+                "status": "success" if is_success else "error",
+                "message": message,
+                "data": data if is_success else None,
+                "error": data if not is_success else None
+            }
+            
+            # Remove content-length as the payload size has changed
+            headers = dict(response.headers)
+            headers.pop("content-length", None)
+            
+            return JSONResponse(
+                content=formatted_response, 
+                status_code=response.status_code, 
+                headers=headers
+            )
+        
+        return response

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

@@ -174,6 +174,9 @@ dependencies = [
     "pymupdf>=1.24.0",
     "pytesseract>=0.3.10",
 {% endif %}
+{% if "caching" in extras %}
+    "fastapi-cache2[redis]>=0.2.1",
+{% endif %}
 {% if "meilisearch" in extras %}
     "meilisearch>=0.30.0",
 {% endif %}

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

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fastapi-spawn"
-version = "0.4.12"
+version = "0.4.14"
 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" }