fastapi-struct 0.1.0__tar.gz → 0.2.0__tar.gz

fastapi_struct-0.2.0/PKG-INFO

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: fastapi-struct
+Version: 0.2.0
+Summary: CLI tool to generate standard, layered enterprise folder structures for FastAPI applications.
+License-Expression: MIT
+Keywords: fastapi,project-structure,boilerplate,scaffold,cli,template,folder-structure,architecture,repository-pattern,rest-api
+Classifier: Programming Language :: Python :: 3
+Classifier: Framework :: FastAPI
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <a href="https://pypi.org/project/fastapi-struct/"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" width="320" alt="fastapi-struct"></a>
+</p>
+<p align="center">
+    <em>CLI tool to generate standard, enterprise-ready, layered folder structures for FastAPI applications in seconds.</em>
+</p>
+<p align="center">
+<a href="https://pypi.org/project/fastapi-struct" target="_blank">
+    <img src="https://img.shields.io/pypi/v/fastapi-struct.svg?color=%2334D058" alt="Package version">
+</a>
+<a href="https://pypi.org/project/fastapi-struct" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/fastapi-struct.svg?color=%2334D058" alt="Supported Python versions">
+</a>
+<a href="https://github.com/fastapi/fastapi" target="_blank">
+    <img src="https://img.shields.io/badge/FastAPI-0.115+-009688.svg?logo=fastapi&logoColor=white" alt="FastAPI">
+</a>
+<a href="https://github.com/pydantic/pydantic" target="_blank">
+    <img src="https://img.shields.io/badge/Pydantic-v2-E92063.svg?logo=pydantic&logoColor=white" alt="Pydantic v2">
+</a>
+<a href="https://opensource.org/licenses/MIT" target="_blank">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT">
+</a>
+</p>
+
+---
+
+**FastAPI Documentation:** [https://fastapi.tiangolo.com](https://fastapi.tiangolo.com)  
+**PyPI Package:** [https://pypi.org/project/fastapi-struct/](https://pypi.org/project/fastapi-struct/)
+
+---
+
+## ⚡ What is `fastapi-struct`?
+
+**`fastapi-struct`** generates a clean, scalable, layered enterprise architecture for FastAPI applications. It organizes code into distinct responsibilities: **API Routes**, **Services**, **Repositories**, **Schemas**, **Models**, and **Core Settings**, avoiding messy spaghetti code and giving you a production-ready codebase instantly.
+
+```bash
+fastapi-struct my_fastapi_project
+```
+
+Or scaffold directly inside your current directory:
+
+```bash
+fastapi-struct .
+```
+
+---
+
+## 🎯 Architecture Diagram & Data Flow
+
+```text
+ ┌────────────────┐
+ │ Client Request │
+ └───────┬────────┘
+         │
+         ▼
+ ┌────────────────────────┐
+ │   API Routes (v1)      │  Handles HTTP requests & route decorators
+ └───────┬────────────────┘
+         │
+         ▼
+ ┌────────────────────────┐
+ │     Services Layer     │  Encapsulates core business logic
+ └───────┬────────────────┘
+         │
+         ▼
+ ┌────────────────────────┐
+ │   Repositories Layer   │  Database interactions & CRUD operations
+ └───────┬────────────────┘
+         │
+         ▼
+ ┌────────────────────────┐
+ │  Database / ORM Models │  SQLAlchemy / SQLModel / Database tables
+ └────────────────────────┘
+```
+
+---
+
+## 📂 Generated Project Structure
+
+```text
+my_fastapi_project/
+│
+├── app/                        # Main application package
+│   ├── __init__.py
+│   ├── main.py                 # FastAPI app initialization & entry point
+│   │
+│   ├── api/                    # API endpoints & route definitions
+│   │   ├── __init__.py
+│   │   └── v1/                 # API Versioning
+│   │       ├── __init__.py
+│   │       ├── api.py          # Central router aggregating endpoints
+│   │       └── routes/         # Route handlers
+│   │           ├── __init__.py
+│   │           ├── items.py    # Endpoint logic for items
+│   │           └── users.py    # Endpoint logic for users
+│   │
+│   ├── core/                   # Application configurations & settings
+│   │   ├── __init__.py
+│   │   ├── config.py           # Environment variables (Pydantic BaseSettings)
+│   │   ├── database.py         # DB connection & session creation
+│   │   └── security.py         # Password hashing & security helpers
+│   │
+│   ├── models/                 # Database ORM models (SQLAlchemy / SQLModel)
+│   │   ├── __init__.py
+│   │   ├── item.py
+│   │   └── user.py
+│   │
+│   ├── schemas/                # Pydantic models for request validation & responses
+│   │   ├── __init__.py
+│   │   ├── item.py
+│   │   └── user.py
+│   │
+│   ├── services/               # Core business logic layer
+│   │   ├── __init__.py
+│   │   ├── item_service.py
+│   │   └── user_service.py
+│   │
+│   ├── repositories/           # Database interactions & CRUD queries layer
+│   │   ├── __init__.py
+│   │   ├── item_repository.py
+│   │   └── user_repository.py
+│   │
+│   └── utils/                  # Utility functions & helpers
+│       ├── __init__.py
+│       └── email.py
+│
+├── tests/                      # Unit and integration tests
+│   ├── __init__.py
+│   ├── conftest.py             # Pytest fixtures
+│   ├── test_items.py           # Item API test cases
+│   └── test_users.py           # User API test cases
+│
+├── .gitignore
+├── .env                        # Environment variables (local)
+├── .env.example                # Sample environment variables template
+├── README.md                   # Project documentation
+├── requirements.txt            # Project dependencies
+└── pyproject.toml              # Build & test configurations
+```
+
+---
+
+## 📦 Installation & Quick Start
+
+### Option 1: Instant with `uvx` *(No installation needed)*
+
+```bash
+uvx fastapi-struct my_fastapi_project
+```
+
+Or inside your existing folder:
+
+```bash
+uvx fastapi-struct .
+```
+
+---
+
+### Option 2: Standard install with `pip`
+
+```bash
+pip install fastapi-struct
+```
+
+Run:
+
+```bash
+fastapi-struct my_fastapi_project
+```
+*(Or inside the current folder: `fastapi-struct .`)*
+
+---
+
+## 🚀 Running Your Generated Project
+
+### 1. Step into the project folder
+```bash
+cd my_fastapi_project
+```
+*(Skip if generated with `fastapi-struct .`)*
+
+### 2. Create and activate a virtual environment
+
+**Windows PowerShell:**
+```powershell
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+```
+
+**Windows CMD:**
+```cmd
+python -m venv .venv
+call .venv\Scripts\activate.bat
+```
+
+**macOS & Linux:**
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+### 3. Install dependencies
+```bash
+pip install -r requirements.txt
+```
+*(Or `pip install -e ".[dev]"`)*
+
+### 4. Start the development server
+```bash
+python -m uvicorn app.main:app --reload
+```
+
+---
+
+## 🔍 Interactive API Documentation
+
+Once running, visit:
+
+- **Swagger UI**: [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)
+- **ReDoc**: [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc)
+
+---
+
+## 🧪 Running Automated Tests
+
+Run the included Pytest suite:
+
+```bash
+python -m pytest
+```
+
+Output:
+```text
+tests\test_items.py ..                                                   [ 50%]
+tests\test_users.py ..                                                   [100%]
+============================== 4 passed in 0.25s ==============================
+```
+
+---
+
+## 📜 License
+
+This project is licensed under the terms of the [MIT License](https://opensource.org/licenses/MIT).

fastapi_struct-0.2.0/README.md

@@ -0,0 +1,243 @@
+<p align="center">
+  <a href="https://pypi.org/project/fastapi-struct/"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" width="320" alt="fastapi-struct"></a>
+</p>
+<p align="center">
+    <em>CLI tool to generate standard, enterprise-ready, layered folder structures for FastAPI applications in seconds.</em>
+</p>
+<p align="center">
+<a href="https://pypi.org/project/fastapi-struct" target="_blank">
+    <img src="https://img.shields.io/pypi/v/fastapi-struct.svg?color=%2334D058" alt="Package version">
+</a>
+<a href="https://pypi.org/project/fastapi-struct" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/fastapi-struct.svg?color=%2334D058" alt="Supported Python versions">
+</a>
+<a href="https://github.com/fastapi/fastapi" target="_blank">
+    <img src="https://img.shields.io/badge/FastAPI-0.115+-009688.svg?logo=fastapi&logoColor=white" alt="FastAPI">
+</a>
+<a href="https://github.com/pydantic/pydantic" target="_blank">
+    <img src="https://img.shields.io/badge/Pydantic-v2-E92063.svg?logo=pydantic&logoColor=white" alt="Pydantic v2">
+</a>
+<a href="https://opensource.org/licenses/MIT" target="_blank">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT">
+</a>
+</p>
+
+---
+
+**FastAPI Documentation:** [https://fastapi.tiangolo.com](https://fastapi.tiangolo.com)  
+**PyPI Package:** [https://pypi.org/project/fastapi-struct/](https://pypi.org/project/fastapi-struct/)
+
+---
+
+## ⚡ What is `fastapi-struct`?
+
+**`fastapi-struct`** generates a clean, scalable, layered enterprise architecture for FastAPI applications. It organizes code into distinct responsibilities: **API Routes**, **Services**, **Repositories**, **Schemas**, **Models**, and **Core Settings**, avoiding messy spaghetti code and giving you a production-ready codebase instantly.
+
+```bash
+fastapi-struct my_fastapi_project
+```
+
+Or scaffold directly inside your current directory:
+
+```bash
+fastapi-struct .
+```
+
+---
+
+## 🎯 Architecture Diagram & Data Flow
+
+```text
+ ┌────────────────┐
+ │ Client Request │
+ └───────┬────────┘
+         │
+         ▼
+ ┌────────────────────────┐
+ │   API Routes (v1)      │  Handles HTTP requests & route decorators
+ └───────┬────────────────┘
+         │
+         ▼
+ ┌────────────────────────┐
+ │     Services Layer     │  Encapsulates core business logic
+ └───────┬────────────────┘
+         │
+         ▼
+ ┌────────────────────────┐
+ │   Repositories Layer   │  Database interactions & CRUD operations
+ └───────┬────────────────┘
+         │
+         ▼
+ ┌────────────────────────┐
+ │  Database / ORM Models │  SQLAlchemy / SQLModel / Database tables
+ └────────────────────────┘
+```
+
+---
+
+## 📂 Generated Project Structure
+
+```text
+my_fastapi_project/
+│
+├── app/                        # Main application package
+│   ├── __init__.py
+│   ├── main.py                 # FastAPI app initialization & entry point
+│   │
+│   ├── api/                    # API endpoints & route definitions
+│   │   ├── __init__.py
+│   │   └── v1/                 # API Versioning
+│   │       ├── __init__.py
+│   │       ├── api.py          # Central router aggregating endpoints
+│   │       └── routes/         # Route handlers
+│   │           ├── __init__.py
+│   │           ├── items.py    # Endpoint logic for items
+│   │           └── users.py    # Endpoint logic for users
+│   │
+│   ├── core/                   # Application configurations & settings
+│   │   ├── __init__.py
+│   │   ├── config.py           # Environment variables (Pydantic BaseSettings)
+│   │   ├── database.py         # DB connection & session creation
+│   │   └── security.py         # Password hashing & security helpers
+│   │
+│   ├── models/                 # Database ORM models (SQLAlchemy / SQLModel)
+│   │   ├── __init__.py
+│   │   ├── item.py
+│   │   └── user.py
+│   │
+│   ├── schemas/                # Pydantic models for request validation & responses
+│   │   ├── __init__.py
+│   │   ├── item.py
+│   │   └── user.py
+│   │
+│   ├── services/               # Core business logic layer
+│   │   ├── __init__.py
+│   │   ├── item_service.py
+│   │   └── user_service.py
+│   │
+│   ├── repositories/           # Database interactions & CRUD queries layer
+│   │   ├── __init__.py
+│   │   ├── item_repository.py
+│   │   └── user_repository.py
+│   │
+│   └── utils/                  # Utility functions & helpers
+│       ├── __init__.py
+│       └── email.py
+│
+├── tests/                      # Unit and integration tests
+│   ├── __init__.py
+│   ├── conftest.py             # Pytest fixtures
+│   ├── test_items.py           # Item API test cases
+│   └── test_users.py           # User API test cases
+│
+├── .gitignore
+├── .env                        # Environment variables (local)
+├── .env.example                # Sample environment variables template
+├── README.md                   # Project documentation
+├── requirements.txt            # Project dependencies
+└── pyproject.toml              # Build & test configurations
+```
+
+---
+
+## 📦 Installation & Quick Start
+
+### Option 1: Instant with `uvx` *(No installation needed)*
+
+```bash
+uvx fastapi-struct my_fastapi_project
+```
+
+Or inside your existing folder:
+
+```bash
+uvx fastapi-struct .
+```
+
+---
+
+### Option 2: Standard install with `pip`
+
+```bash
+pip install fastapi-struct
+```
+
+Run:
+
+```bash
+fastapi-struct my_fastapi_project
+```
+*(Or inside the current folder: `fastapi-struct .`)*
+
+---
+
+## 🚀 Running Your Generated Project
+
+### 1. Step into the project folder
+```bash
+cd my_fastapi_project
+```
+*(Skip if generated with `fastapi-struct .`)*
+
+### 2. Create and activate a virtual environment
+
+**Windows PowerShell:**
+```powershell
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+```
+
+**Windows CMD:**
+```cmd
+python -m venv .venv
+call .venv\Scripts\activate.bat
+```
+
+**macOS & Linux:**
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+### 3. Install dependencies
+```bash
+pip install -r requirements.txt
+```
+*(Or `pip install -e ".[dev]"`)*
+
+### 4. Start the development server
+```bash
+python -m uvicorn app.main:app --reload
+```
+
+---
+
+## 🔍 Interactive API Documentation
+
+Once running, visit:
+
+- **Swagger UI**: [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)
+- **ReDoc**: [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc)
+
+---
+
+## 🧪 Running Automated Tests
+
+Run the included Pytest suite:
+
+```bash
+python -m pytest
+```
+
+Output:
+```text
+tests\test_items.py ..                                                   [ 50%]
+tests\test_users.py ..                                                   [100%]
+============================== 4 passed in 0.25s ==============================
+```
+
+---
+
+## 📜 License
+
+This project is licensed under the terms of the [MIT License](https://opensource.org/licenses/MIT).

{fastapi_struct-0.1.0 → fastapi_struct-0.2.0}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fastapi-struct"
-version = "0.1.0"
-description = "CLI tool to generate standard folder structure for FastAPI applications."
+version = "0.2.0"
+description = "CLI tool to generate standard, layered enterprise folder structures for FastAPI applications."
 readme = "README.md"
 requires-python = ">=3.10"
 license = "MIT"
@@ -17,6 +17,9 @@ keywords = [
     "cli",
     "template",
     "folder-structure",
+    "architecture",
+    "repository-pattern",
+    "rest-api",
 ]
 classifiers = [
     "Programming Language :: Python :: 3",

fastapi_struct-0.2.0/src/create_fastapi_app/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.0"

{fastapi_struct-0.1.0 → fastapi_struct-0.2.0}/src/create_fastapi_app/generator.py

@@ -1,33 +1,44 @@
-from pathlib import Path
-import re
-import shutil
-
-PACKAGE_DIR = Path(__file__).parent
-TEMPLATE_DIR = PACKAGE_DIR / "templates" / "basic"
-
-
-def create_project(name: str) -> Path:
-    if name == ".":
-        project_path = Path.cwd()
-        project_name = project_path.name
-    else:
-        if not re.fullmatch(r"[A-Za-z][A-Za-z0-9_-]*", name):
-            raise ValueError(
-                "Project name must start with a letter and contain "
-                "only letters, numbers, underscores, or hyphens."
-            )
-        project_path = Path.cwd() / name
-        project_name = name
-
-    # Copy files allowing existing directory
-    shutil.copytree(TEMPLATE_DIR, project_path, dirs_exist_ok=True)
-
-    config_path = project_path / "pyproject.toml"
-    config = config_path.read_text(encoding="utf-8")
-    config = config.replace(
-        'name = "my-api"',
-        f'name = "{project_name.lower().replace("_", "-")}"',
-    )
-    config_path.write_text(config, encoding="utf-8")
-
-    return project_path
+from pathlib import Path
+import re
+import shutil
+
+PACKAGE_DIR = Path(__file__).parent
+TEMPLATE_DIR = PACKAGE_DIR / "templates" / "basic"
+
+
+def create_project(name: str) -> Path:
+    if name == ".":
+        project_path = Path.cwd()
+        project_name = project_path.name
+    else:
+        if not re.fullmatch(r"[A-Za-z][A-Za-z0-9_-]*", name):
+            raise ValueError(
+                "Project name must start with a letter and contain "
+                "only letters, numbers, underscores, or hyphens."
+            )
+        project_path = Path.cwd() / name
+        project_name = name
+
+        if project_path.exists():
+            raise FileExistsError(
+                f"Destination directory already exists: {project_path}"
+            )
+
+    if not TEMPLATE_DIR.is_dir():
+        raise FileNotFoundError(
+            f"Template directory not found: {TEMPLATE_DIR}"
+        )
+
+    # Copy files allowing existing directory (useful when name is '.')
+    shutil.copytree(TEMPLATE_DIR, project_path, dirs_exist_ok=True)
+
+    config_path = project_path / "pyproject.toml"
+    if config_path.exists():
+        config = config_path.read_text(encoding="utf-8")
+        config = config.replace(
+            'name = "my-api"',
+            f'name = "{project_name.lower().replace("_", "-")}"',
+        )
+        config_path.write_text(config, encoding="utf-8")
+
+    return project_path

fastapi_struct-0.2.0/src/create_fastapi_app/templates/basic/.env

@@ -0,0 +1,4 @@
+PROJECT_NAME="FastAPI Enterprise Application"
+API_V1_STR="/api/v1"
+DEBUG=true
+SECRET_KEY="supersecretkeyforproductiondevelopmentchangeinprod"

fastapi_struct-0.2.0/src/create_fastapi_app/templates/basic/.env.example

@@ -0,0 +1,4 @@
+PROJECT_NAME="FastAPI Enterprise Application"
+API_V1_STR="/api/v1"
+DEBUG=true
+SECRET_KEY="your_secret_key_here"

{fastapi_struct-0.1.0 → fastapi_struct-0.2.0}/src/create_fastapi_app/templates/basic/.gitignore

@@ -4,3 +4,6 @@ __pycache__/
 .pytest_cache/
 *.py[cod]
 *.db
+dist/
+build/
+*.egg-info/

fastapi_struct-0.2.0/src/create_fastapi_app/templates/basic/README.md

@@ -0,0 +1,35 @@
+# FastAPI Application
+
+Enterprise-grade modular FastAPI application generated with `fastapi-struct`.
+
+## Quick Start
+
+### 1. Create Virtual Environment
+```bash
+python -m venv .venv
+```
+
+Activate:
+- Windows PowerShell: `.\.venv\Scripts\Activate.ps1`
+- Windows CMD: `call .venv\Scripts\activate.bat`
+- Linux/macOS: `source .venv/bin/activate`
+
+### 2. Install Dependencies
+```bash
+pip install -r requirements.txt
+```
+*(or `pip install -e ".[dev]"`)*
+
+### 3. Run Development Server
+```bash
+python -m uvicorn app.main:app --reload
+```
+
+Interactive API docs available at:
+- Swagger UI: http://127.0.0.1:8000/docs
+- ReDoc: http://127.0.0.1:8000/redoc
+
+### 4. Run Tests
+```bash
+python -m pytest
+```

fastapi_struct-0.2.0/src/create_fastapi_app/templates/basic/app/api/v1/api.py

@@ -0,0 +1,6 @@
+from fastapi import APIRouter
+from app.api.v1.routes import items, users
+
+api_router = APIRouter()
+api_router.include_router(items.router)
+api_router.include_router(users.router)

fastapi_struct-0.2.0/src/create_fastapi_app/templates/basic/app/api/v1/routes/items.py

@@ -0,0 +1,23 @@
+from fastapi import APIRouter, HTTPException, status
+from app.schemas.item import ItemCreate, ItemResponse
+from app.services.item_service import item_service
+
+router = APIRouter(prefix="/items", tags=["Items"])
+
+
+@router.get("/", response_model=list[ItemResponse])
+async def read_items():
+    return item_service.list_items()
+
+
+@router.post("/", response_model=ItemResponse, status_code=status.HTTP_201_CREATED)
+async def create_item(item_in: ItemCreate):
+    return item_service.create_item(item_in)
+
+
+@router.get("/{item_id}", response_model=ItemResponse)
+async def read_item(item_id: int):
+    item = item_service.get_item(item_id)
+    if not item:
+        raise HTTPException(status_code=404, detail="Item not found")
+    return item