fastapi-assist 0.1.0__py3-none-any.whl

fa_assist/cli.py

@@ -0,0 +1,44 @@
+from pathlib import Path
+
+import typer
+
+from fa_assist.commands.init import init_project
+from .util import (
+    check_or_raise_error,
+    get_project_name_into_config,
+    set_project_name_into_config,
+)
+from fa_assist.commands.create import create_app
+
+app = typer.Typer(name="fa_assist", help="FastAPI development assistant.")
+
+
+@app.command("init")
+def init(
+    project_type: str,
+    project_name: str,
+    path: str = ".",
+):
+
+    check_or_raise_error(
+        project_type == "project",
+        "Provide project as resource to create a new FastAPI project.",
+    )
+    init_project(project_name, path)
+    set_project_name_into_config(project_name)
+
+
+@app.command("add")
+def add(
+    resource: str,
+    app_name: str,
+):
+    check_or_raise_error(
+        resource == "app", "Provide app as resource to create a new FastAPI app."
+    )
+    project_name = get_project_name_into_config()
+    create_app(project_name, app_name)
+
+
+def main():
+    app()

fa_assist/commands/create.py

@@ -0,0 +1,78 @@
+from pathlib import Path
+from ..files_code.app_structure import *
+
+
+def create_app(project_name, app_name: str):
+    """
+    Creates a new FastAPI app with the given name.
+    """
+
+    # ---------------------------------------------------------
+    # 1. Get current FastAPI project
+    # ---------------------------------------------------------
+    project_path = Path.cwd()
+
+    apps_path = project_path / project_name / "apps"
+    if not apps_path.exists():
+        raise FileNotFoundError(
+            "apps directory not found. "
+            "Make sure you are running this command "
+            "from a FastAPI project."
+        )
+
+    # ---------------------------------------------------------
+    # 2. Create app directory
+    # ---------------------------------------------------------
+    app_path = apps_path / app_name
+
+    if app_path.exists():
+        raise FileExistsError(f"App '{app_name}' already exists.")
+
+    app_path.mkdir(parents=True)
+
+    # ---------------------------------------------------------
+    # 3. Create directories
+    # ---------------------------------------------------------
+    directories = [
+        app_path / "views",
+        app_path / "schemas",
+    ]
+
+    for directory in directories:
+        directory.mkdir(
+            parents=True,
+            exist_ok=True,
+        )
+
+    # ---------------------------------------------------------
+    # 4. Create files
+    # ---------------------------------------------------------
+    files = {
+        "__init__.py": INIT_PY.format(app=app_name),
+        "views/__init__.py": VIEW_INIT_PY,
+        f"views/api_{app_name}_view.py": VIEW_PY.format(app=app_name),
+        "schemas/__init__.py": "",
+        "utils.py": UTILS_PY,
+        "models.py": MODELS_PY,
+        "constants.py": CONSTANT_PY,
+        "enums.py": "",
+        "dependencies.py": "",
+        "internal_api_calls.py": "",
+    }
+
+    # ---------------------------------------------------------
+    # 5. Write files
+    # ---------------------------------------------------------
+    for relative_path, content in files.items():
+
+        file_path = app_path / relative_path
+
+        file_path.write_text(
+            content,
+            encoding="utf-8",
+        )
+
+    print()
+    print(f"✓ FastAPI app '{app_name}' " f"created successfully.")
+    print(f"  Location: {app_path}")
+    print()

fa_assist/commands/init.py

@@ -0,0 +1,78 @@
+from pathlib import Path
+from ..files_code.project_structure import *
+
+def init_project(project_name: str, path: str):
+    """
+    Initialize a new FastAPI project with the standard
+    FastAPI Assist project structure.
+    """
+
+    # ---------------------------------------------------------
+    # 1. Create project root
+    # ---------------------------------------------------------
+    project_path = Path(path).resolve() / project_name
+
+    if project_path.exists():
+        raise FileExistsError(
+            f"Project '{project_name}' already exists at: {project_path}"
+        )
+
+        # ---------------------------------------------------------
+    # 3. Create directories
+    # ---------------------------------------------------------
+    directories = [
+        project_path / "logs",
+        project_path / "credential",
+        project_path / "independent_scripts",
+    ]
+
+    for directory in directories:
+        directory.mkdir(parents=True, exist_ok=True)
+
+    # ---------------------------------------------------------
+    # 2. Create files with their initial content
+    # ---------------------------------------------------------
+
+    files = {
+        "main.py": MAIN_PY,
+        ".env": DOT_ENV_FILE,
+
+        "configuration/config.py": CONFIG_PY.format(project_name=project_name),
+        "configuration/custom_error.py": CUSTOM_ERROR_PY,
+        "configuration/db.py": DB_PY,
+        "configuration/logger.py": LOGGER_PY,
+        "configuration/rate_limit.py": RATE_LIMIT_PY,
+        "configuration/server.py": SERVER_PY.format(project_name=project_name),
+
+        "apps/__init__.py": APPS_INIT_PY,
+        "apps/constants.py": CONSTANT_PY,
+        "apps/db_operations.py": DB_OPERATIONS_PY,
+        "apps/https_response.py": HTTPS_RESPONSE_PY,
+        "apps/models.py": MODELS_PY,
+        "apps/reg_models.py": REG_MODELS_PY,
+        "apps/reg_routers.py": REG_ROUTERS_PY,
+        "apps/schemas.py": SCHEMAS_PY,
+        "apps/utils.py": UTILS_PY,
+
+        "Dockerfile": DOCKER,
+        ".docker-compose.yaml": DOCKER_COMPOSE.format(project_name=project_name),
+        "docker_setup.sh": DOCKER_SETUP_SH,
+
+        "deployment.sh": DEPLOYMENT_SH.format(project_name=project_name),
+    }
+
+    for relative_path, content in files.items():
+        file_path = project_path / relative_path
+
+        # Make sure the parent directory exists
+        file_path.parent.mkdir(parents=True, exist_ok=True)
+
+        file_path.write_text(
+            content,
+            encoding="utf-8",
+        )
+
+    print()
+    print(f"✓ FastAPI project '{project_name}' created successfully.")
+    print(f"  Location: {project_path}")
+    print()

fa_assist/files_code/app_structure.py

@@ -0,0 +1,80 @@
+UTILS_PY = """
+
+def success_response(
+    data=None,
+    message="Success",
+):
+    return {
+        "success": True,
+        "message": message,
+        "data": data,
+    }
+
+
+def error_response(
+    message="Something went wrong",
+):
+    return {
+        "success": False,
+        "message": message,
+        "data": None,
+    }
+    
+    
+"""
+CONSTANT_PY = """
+
+"""
+
+MODELS_PY = """
+
+"""
+
+INIT_PY = """
+
+from configuration.logger import create_get_logger
+    
+get_logger = create_get_logger("{app}")
+
+"""
+
+VIEW_INIT_PY = """
+
+import pkgutil, importlib
+from . import *
+from fastapi import APIRouter
+
+_file_routers = tuple()
+
+for file in pkgutil.iter_modules(__path__):
+    _file = importlib.import_module(f"{__name__}.{file.name}")
+    if hasattr(_file, "routers"):
+        _file_routers += (_file.routers, )
+
+__routers: tuple[APIRouter, ...] = _file_routers
+
+"""
+
+VIEW_PY = """
+
+from pathlib import Path
+import traceback
+
+import pandas as pd
+from tortoise.expressions import Q
+
+from apps import generate_router as APIRoute
+from apps.db_operations import read_instances
+from apps.https_response import error_response, success_response
+from fastapi import Body, Depends
+from ...{app} import get_logger
+
+routers = APIRoute('/{app}', tags=["{app} View Section"])
+logger = get_logger("{app}_view")
+
+@routers.get("")
+async def api_view():
+    logger.info("API view called")
+    return success_response(data = "", message = "success")
+    
+"""