fastbrick 0.5__tar.gz → 0.5.1__tar.gz

fastbrick-0.5.1/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.1
+Name: fastbrick
+Version: 0.5.1
+Summary: A CLI tool for generating FastAPI projects and apps
+Home-page: UNKNOWN
+Author: Sandeep Singh Negi
+Author-email: sandeepnegi1710@gmail.com
+License: UNKNOWN
+Description: # FastBrick 🚀
+        
+        A simple CLI tool to generate FastAPI project structures.
+        
+        ## Installation
+        
+        Install FastBrick using:
+        ```sh
+        pip install fastbrick
+        ```
+        
+        ## Run Server
+        
+        Start the FastAPI server with:
+        ```sh
+        uvicorn main:app --reload
+        ```
+        
+        ## Help Command
+        
+        To see available options and commands:
+        ```sh
+        fastbrick --help
+        ```
+        
+        ## Usage
+        Create a New Project
+        Creates a new FastAPI project with a structured layout.
+        ```sh
+        fastbrick create-project my_project
+        ```
+        Create a New App
+        Creates a new FastAPI app (router) with database settings.
+        
+        ```sh
+        fastbirck create-app my_app
+        ```
+        
+        ## Project Structure
+        
+        ```
+        myproject/
+        │── main.py          # Entry point for FastAPI app
+        │── routes.py        # Contains 'app routes'
+        │── models.py
+        │── schemas.py
+        │── middlewares/
+        │   ├── middleware.py  # Global middleware logic
+        │── routers/         # API route modules
+        │── settings/
+        │   ├── config.py  # Database configuration
+        │   ├── database.py  # Database configuration
+        │   ├── routing.py   # Router configurations
+        ```
+        
+        This structure ensures modularity and scalability for your FastAPI project. Adjust the folders and files as needed based on your project requirements.
+        
+        
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown

fastbrick-0.5.1/fastbrick/cli.py

@@ -0,0 +1,262 @@
+import os
+import click
+from jinja2 import Template
+
+# Default template for main.py
+MAIN_TEMPLATE = """\
+from fastapi import FastAPI
+from middlewares.middleware import GlobalMiddleware
+from settings.routing import router
+from settings.database import engine, Base
+
+# ✅ Create all tables in the database
+Base.metadata.create_all(bind=engine)
+
+app = FastAPI()
+
+# ✅ Add Middleware
+app.add_middleware(GlobalMiddleware)
+
+# ✅ Include API routes
+app.include_router(router)
+
+@app.get("/")
+def root():
+    return {"message": "Welcome to FastAPI Project"}
+"""
+
+# Default template for new app routers
+APP_ROUTER_TEMPLATE = """\
+from fastapi import APIRouter
+
+router = APIRouter()
+
+@router.get("/")
+def {{ app_name }}_home():
+    return {"message": "Welcome to the {{ app_name }} app"}
+"""
+
+# Default template for database settings
+DATABASE_TEMPLATE = """\
+from sqlalchemy import create_engine, MetaData
+from sqlalchemy.orm import sessionmaker, declarative_base
+from settings.config import DATABASE_URL
+
+engine = create_engine(DATABASE_URL, connect_args={"check_same_thread": False})
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+Base = declarative_base()
+
+# Dependency: Get DB Session
+def get_db():
+    db = SessionLocal()
+    try:
+        yield db
+    finally:
+        db.close()
+
+"""
+
+# Template for dynamic routing
+ROUTING_TEMPLATE = """\
+import importlib
+import pkgutil
+from fastapi import APIRouter
+import routers
+
+# Import custom route mappings from routes.py
+from routes import app_routes
+
+router = APIRouter()
+
+# Dynamically import and include all routers from 'routers' package
+for _, module_name, _ in pkgutil.iter_modules(routers.__path__):
+    module = importlib.import_module(f"routers.{module_name}")
+    
+    if hasattr(module, "router"):
+        prefix = app_routes.get(module_name, f"/{module_name}")
+        router.include_router(module.router, prefix=prefix, tags=[module_name.capitalize()])
+"""
+
+# routes.py template (Separate file for `app_routes`)
+ROUTES_TEMPLATE = """\
+# Users can modify this dictionary to change route prefixes
+app_routes = {}
+"""
+
+MODELS_TEMPLATE = """\
+from sqlalchemy import Column, Integer, String
+from settings.database import Base
+
+class User(Base):
+    __tablename__ = "users"
+    id = Column(Integer, primary_key=True, index=True)
+    email = Column(String, unique=True, index=True)
+    hashed_password = Column(String)
+"""
+
+SCHEMAS_TEMPLATE = """\
+from pydantic import BaseModel
+
+class UserBase(BaseModel):
+    email: str
+    hashed_password: str
+
+"""
+
+MIDDLEWARE_TEMPLATE = """\
+import time
+import logging
+from fastapi import Request, Response
+from starlette.middleware.base import BaseHTTPMiddleware
+from settings.config import ALLOWED_IPS
+
+# Configure logging
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger("middleware")
+
+
+class GlobalMiddleware(BaseHTTPMiddleware):
+    async def dispatch(self, request: Request, call_next):
+        start_time = time.time()
+        client_ip = request.client.host
+
+        # ✅ Allow Only Specific IPs
+        if "*" not in ALLOWED_IPS and client_ip not in ALLOWED_IPS:
+            return Response(content="⛔ Access Denied", status_code=403)
+
+        # ⏳ Process Request
+        try:
+            response = await call_next(request)
+        except Exception as e:
+            logger.error(f"❌ Exception: {e}")
+            return Response(content="🚨 Internal Server Error", status_code=500)
+
+        # ⏱️ Track Request Time
+        process_time = time.time() - start_time
+        response.headers["X-Process-Time"] = str(process_time)
+        response.headers["X-App-Version"] = "1.0.0"
+
+        logger.info(f"✅ {request.method} {request.url} - {response.status_code} ({process_time:.4f}s)")
+        return response
+"""
+
+CONFIG_TEMPLATE="""\
+DATABASE_URL = "sqlite:///./test.db"
+
+# Define Allowed IPs
+ALLOWED_IPS = {"*"}  # Set specific IPs to restrict access, or "*" to allow all
+"""
+
+@click.group()
+def cli():
+    """FastAPI Project Generator CLI"""
+    pass
+
+@click.command(name="create-project")
+@click.argument("name")
+def create_project(name):
+    """Create a new FastAPI project with a clean structure."""
+    
+    if os.path.exists(name):
+        click.echo(f"❌ Error: Project '{name}' already exists! Choose a different name.")
+        return
+    
+    # Create project directories
+    os.makedirs(f"{name}/routers", exist_ok=True)
+    os.makedirs(f"{name}/settings", exist_ok=True)
+    os.makedirs(f"{name}/alembic", exist_ok=True)
+    os.makedirs(f"{name}/middlewares", exist_ok=True)
+
+    # Create main.py
+    with open(f"{name}/main.py", "w") as f:
+        f.write(Template(MAIN_TEMPLATE).render(project_name=name))
+
+    # Create settings/database.py
+    with open(f"{name}/settings/database.py", "w") as f:
+        f.write(DATABASE_TEMPLATE)
+
+    # Create settings/routing.py
+    with open(f"{name}/settings/routing.py", "w") as f:
+        f.write(ROUTING_TEMPLATE)
+
+    # Create settings/config.py
+    with open(f"{name}/settings/config.py", "w") as f:
+        f.write(CONFIG_TEMPLATE)
+
+    # Create middlewares/middleware.py
+    with open(f"{name}/middlewares/middleware.py", "w") as f:
+        f.write(MIDDLEWARE_TEMPLATE)
+
+    # Create models.py
+    with open(f"{name}/models.py", "w") as f:
+        f.write(MODELS_TEMPLATE)
+
+    # Create schemas.py
+    with open(f"{name}/schemas.py", "w") as f:
+        f.write(SCHEMAS_TEMPLATE)
+
+    # Create routes.py
+    with open(f"{name}/routes.py", "w") as f:
+        f.write(ROUTES_TEMPLATE)
+
+    click.echo(f"✅ FastAPI project '{name}' created successfully!")
+
+
+@click.command(name="create-app")
+@click.argument("name")
+def create_app(name):
+    """Create a new FastAPI app (router) with database settings."""
+    app_path = f"routers/{name}.py"
+    settings_path = "settings/"
+    routing_config_path = os.path.join(settings_path, "routing.py")
+
+    if not os.path.exists("routers"):
+        click.echo("❌ Error: No 'routers' directory found! Are you inside a FastAPI project?")
+        return
+
+    if os.path.exists(app_path):
+        click.echo(f"❌ Error: App '{name}' already exists! Choose a different name.")
+        return
+
+    # Ensure settings folder exists
+    os.makedirs(settings_path, exist_ok=True)
+
+    # Create router file
+    with open(app_path, "w") as f:
+        f.write(Template(APP_ROUTER_TEMPLATE).render(app_name=name))
+
+    # Ensure database.py exists inside settings/
+    db_config_path = os.path.join(settings_path, "database.py")
+    if not os.path.exists(db_config_path):
+        with open(db_config_path, "w") as f:
+            f.write(DATABASE_TEMPLATE)
+
+    # Ensure routing.py exists inside settings/
+    if not os.path.exists(routing_config_path):
+        with open(routing_config_path, "w") as f:
+            f.write(ROUTING_TEMPLATE)
+
+    # Ensure routes.py exists outside settings/
+    if not os.path.exists("routes.py"):
+        with open("routes.py", "w") as f:
+            f.write(ROUTING_TEMPLATE)
+
+    # Update `settings/routing.py` with the new default prefix
+    with open("routes.py", "r+") as f:
+        content = f.read()
+        if "app_routes = {" in content:
+            new_entry = f'    "{name}": "/{name}",\n'
+            if f'"{name}":' not in content:  # Prevent duplicate entries
+                updated_content = content.replace("app_routes = {", f"app_routes = {{\n{new_entry}")
+                f.seek(0)
+                f.write(updated_content)
+                f.truncate()
+
+    click.echo(f"✅ App '{name}' created successfully")
+
+
+cli.add_command(create_project)
+cli.add_command(create_app)
+
+if __name__ == "__main__":
+    cli()

fastbrick-0.5.1/fastbrick.egg-info/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.1
+Name: fastbrick
+Version: 0.5.1
+Summary: A CLI tool for generating FastAPI projects and apps
+Home-page: UNKNOWN
+Author: Sandeep Singh Negi
+Author-email: sandeepnegi1710@gmail.com
+License: UNKNOWN
+Description: # FastBrick 🚀
+        
+        A simple CLI tool to generate FastAPI project structures.
+        
+        ## Installation
+        
+        Install FastBrick using:
+        ```sh
+        pip install fastbrick
+        ```
+        
+        ## Run Server
+        
+        Start the FastAPI server with:
+        ```sh
+        uvicorn main:app --reload
+        ```
+        
+        ## Help Command
+        
+        To see available options and commands:
+        ```sh
+        fastbrick --help
+        ```
+        
+        ## Usage
+        Create a New Project
+        Creates a new FastAPI project with a structured layout.
+        ```sh
+        fastbrick create-project my_project
+        ```
+        Create a New App
+        Creates a new FastAPI app (router) with database settings.
+        
+        ```sh
+        fastbirck create-app my_app
+        ```
+        
+        ## Project Structure
+        
+        ```
+        myproject/
+        │── main.py          # Entry point for FastAPI app
+        │── routes.py        # Contains 'app routes'
+        │── models.py
+        │── schemas.py
+        │── middlewares/
+        │   ├── middleware.py  # Global middleware logic
+        │── routers/         # API route modules
+        │── settings/
+        │   ├── config.py  # Database configuration
+        │   ├── database.py  # Database configuration
+        │   ├── routing.py   # Router configurations
+        ```
+        
+        This structure ensures modularity and scalability for your FastAPI project. Adjust the folders and files as needed based on your project requirements.
+        
+        
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown

{fastbrick-0.5 → fastbrick-0.5.1}/fastbrick.egg-info/SOURCES.txt

@@ -1,6 +1,8 @@
 LICENSE
 README.md
 setup.py
+fastbrick/__init__.py
+fastbrick/cli.py
 fastbrick.egg-info/PKG-INFO
 fastbrick.egg-info/SOURCES.txt
 fastbrick.egg-info/dependency_links.txt

fastbrick-0.5.1/fastbrick.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+fastbrick = fastbrick.cli:cli
+

fastbrick-0.5.1/fastbrick.egg-info/top_level.txt

@@ -0,0 +1 @@
+fastbrick

{fastbrick-0.5 → fastbrick-0.5.1}/setup.py

@@ -7,7 +7,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name="fastbrick",
-    version="0.5",
+    version="0.5.1",
     author="Sandeep Singh Negi",  # 👈 
     author_email="sandeepnegi1710@gmail.com",  # 👈 
     description="A CLI tool for generating FastAPI projects and apps",
@@ -17,7 +17,7 @@ setup(
     install_requires=["fastapi", "click", "jinja2"],
     entry_points={
         "console_scripts": [
-            "fastbrick = fastbrick:cli",
+            "fastbrick = fastbrick.cli:cli",
         ],
     },
     classifiers=[

fastbrick-0.5/PKG-INFO

@@ -1,75 +0,0 @@
-Metadata-Version: 2.1
-Name: fastbrick
-Version: 0.5
-Summary: A CLI tool for generating FastAPI projects and apps
-Home-page: UNKNOWN
-Author: Sandeep Singh Negi
-Author-email: sandeepnegi1710@gmail.com
-License: UNKNOWN
-Platform: UNKNOWN
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# FastBrick 🚀
-
-A simple CLI tool to generate FastAPI project structures.
-
-## Installation
-
-Install FastBrick using:
-```sh
-pip install fastbrick
-```
-
-## Run Server
-
-Start the FastAPI server with:
-```sh
-uvicorn main:app --reload
-```
-
-## Help Command
-
-To see available options and commands:
-```sh
-fastbrick --help
-```
-
-## Usage
-Create a New Project
-Creates a new FastAPI project with a structured layout.
-```sh
-fastbrick create-project my_project
-```
-Create a New App
-Creates a new FastAPI app (router) with database settings.
-
-```sh
-fastbirck create-app my_app
-```
-
-## Project Structure
-
-```
-myproject/
-│── main.py          # Entry point for FastAPI app
-│── routes.py        # Contains 'app routes'
-│── models.py
-│── schemas.py
-│── middlewares/
-│   ├── middleware.py  # Global middleware logic
-│── routers/         # API route modules
-│── settings/
-│   ├── config.py  # Database configuration
-│   ├── database.py  # Database configuration
-│   ├── routing.py   # Router configurations
-```
-
-This structure ensures modularity and scalability for your FastAPI project. Adjust the folders and files as needed based on your project requirements.
-
-
-

fastbrick-0.5/fastbrick.egg-info/PKG-INFO

@@ -1,75 +0,0 @@
-Metadata-Version: 2.1
-Name: fastbrick
-Version: 0.5
-Summary: A CLI tool for generating FastAPI projects and apps
-Home-page: UNKNOWN
-Author: Sandeep Singh Negi
-Author-email: sandeepnegi1710@gmail.com
-License: UNKNOWN
-Platform: UNKNOWN
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# FastBrick 🚀
-
-A simple CLI tool to generate FastAPI project structures.
-
-## Installation
-
-Install FastBrick using:
-```sh
-pip install fastbrick
-```
-
-## Run Server
-
-Start the FastAPI server with:
-```sh
-uvicorn main:app --reload
-```
-
-## Help Command
-
-To see available options and commands:
-```sh
-fastbrick --help
-```
-
-## Usage
-Create a New Project
-Creates a new FastAPI project with a structured layout.
-```sh
-fastbrick create-project my_project
-```
-Create a New App
-Creates a new FastAPI app (router) with database settings.
-
-```sh
-fastbirck create-app my_app
-```
-
-## Project Structure
-
-```
-myproject/
-│── main.py          # Entry point for FastAPI app
-│── routes.py        # Contains 'app routes'
-│── models.py
-│── schemas.py
-│── middlewares/
-│   ├── middleware.py  # Global middleware logic
-│── routers/         # API route modules
-│── settings/
-│   ├── config.py  # Database configuration
-│   ├── database.py  # Database configuration
-│   ├── routing.py   # Router configurations
-```
-
-This structure ensures modularity and scalability for your FastAPI project. Adjust the folders and files as needed based on your project requirements.
-
-
-

fastbrick-0.5/fastbrick.egg-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-fastbrick = fastbrick:cli
-

fastbrick-0.5/fastbrick.egg-info/top_level.txt

@@ -1 +0,0 @@
-

{fastbrick-0.5 → fastbrick-0.5.1}/fastbrick.egg-info/requires.txt

@@ -1,3 +1,3 @@
-click
 fastapi
+click
 jinja2