fastapi-struct 0.1.0__tar.gz

fastapi_struct-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include src/create_fastapi_app/templates *
+recursive-include src/create_fastapi_app/templates .*

fastapi_struct-0.1.0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: fastapi-struct
+Version: 0.1.0
+Summary: CLI tool to generate standard folder structure for FastAPI applications.
+License-Expression: MIT
+Keywords: fastapi,project-structure,boilerplate,scaffold,cli,template,folder-structure
+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
+
+# fastapi-struct
+
+CLI tool to generate standard, production-ready folder structures for FastAPI applications.
+
+## Usage
+
+### Instant with uvx (no installation needed)
+```bash
+uvx fastapi-struct my-api
+```
+Or in the current folder:
+```bash
+uvx fastapi-struct .
+```
+
+### Or install via pip
+```bash
+pip install fastapi-struct
+fastapi-struct my-api
+```
+*(You can also use `create-fastapi-app my-api`)*
+
+## Generated Project Next Steps
+
+```powershell
+cd my-api
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip install -e ".[dev]"
+python -m uvicorn app.main:app --reload
+```
+
+Interactive API documentation will be available at:
+http://127.0.0.1:8000/docs

fastapi_struct-0.1.0/README.md

@@ -0,0 +1,34 @@
+# fastapi-struct
+
+CLI tool to generate standard, production-ready folder structures for FastAPI applications.
+
+## Usage
+
+### Instant with uvx (no installation needed)
+```bash
+uvx fastapi-struct my-api
+```
+Or in the current folder:
+```bash
+uvx fastapi-struct .
+```
+
+### Or install via pip
+```bash
+pip install fastapi-struct
+fastapi-struct my-api
+```
+*(You can also use `create-fastapi-app my-api`)*
+
+## Generated Project Next Steps
+
+```powershell
+cd my-api
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip install -e ".[dev]"
+python -m uvicorn app.main:app --reload
+```
+
+Interactive API documentation will be available at:
+http://127.0.0.1:8000/docs

fastapi_struct-0.1.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fastapi-struct"
+version = "0.1.0"
+description = "CLI tool to generate standard folder structure for FastAPI applications."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+keywords = [
+    "fastapi",
+    "project-structure",
+    "boilerplate",
+    "scaffold",
+    "cli",
+    "template",
+    "folder-structure",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Framework :: FastAPI",
+    "Topic :: Software Development :: Code Generators",
+    "Operating System :: OS Independent",
+]
+dependencies = []
+
+[project.scripts]
+fastapi-struct = "create_fastapi_app.cli:main"
+create-fastapi-app = "create_fastapi_app.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+create_fastapi_app = ["templates/**/*", "templates/**/.*"]

fastapi_struct-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fastapi_struct-0.1.0/src/create_fastapi_app/__init__.py

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

fastapi_struct-0.1.0/src/create_fastapi_app/cli.py

@@ -0,0 +1,46 @@
+import argparse
+import sys
+
+from create_fastapi_app import __version__
+from create_fastapi_app.generator import create_project
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="create-fastapi-app",
+        description="Create a new FastAPI project.",
+    )
+    parser.add_argument(
+        "name",
+        nargs="?",
+        help="Name of the project to generate (or . for current directory)",
+    )
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s {__version__}",
+    )
+
+    args = parser.parse_args()
+
+    if not args.name:
+        parser.print_help()
+        sys.exit(2)
+
+    try:
+        path = create_project(args.name)
+    except (ValueError, FileExistsError, FileNotFoundError) as exc:
+        parser.error(str(exc))
+
+    print(f"\nSuccess! Created project at: {path}")
+    print("\nNext steps:")
+    if args.name != ".":
+        print(f"  cd {args.name}")
+    print("  python -m venv .venv")
+    print(r"  .\.venv\Scripts\Activate.ps1")
+    print('  python -m pip install -e ".[dev]"')
+    print("  python -m uvicorn app.main:app --reload")
+
+
+if __name__ == "__main__":
+    main()

fastapi_struct-0.1.0/src/create_fastapi_app/generator.py

@@ -0,0 +1,33 @@
+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

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

@@ -0,0 +1,2 @@
+PROJECT_NAME=My FastAPI App
+DEBUG=true

fastapi_struct-0.1.0/src/create_fastapi_app/templates/basic/.gitignore

@@ -0,0 +1,6 @@
+.venv/
+__pycache__/
+.env
+.pytest_cache/
+*.py[cod]
+*.db

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

@@ -0,0 +1,23 @@
+# My FastAPI Application
+
+## Install
+
+```powershell
+python -m pip install -e ".[dev]"
+```
+
+## Run
+
+```powershell
+python -m uvicorn app.main:app --reload
+```
+
+## Test
+
+```powershell
+python -m pytest
+```
+
+## Documentation
+
+Visit http://127.0.0.1:8000/docs

fastapi_struct-0.1.0/src/create_fastapi_app/templates/basic/app/core/config.py

@@ -0,0 +1,14 @@
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class Settings(BaseSettings):
+    PROJECT_NAME: str = "My FastAPI App"
+    DEBUG: bool = True
+
+    model_config = SettingsConfigDict(
+        env_file=".env",
+        extra="ignore",
+    )
+
+
+settings = Settings()

fastapi_struct-0.1.0/src/create_fastapi_app/templates/basic/app/db/database.py

@@ -0,0 +1 @@
+"""Database engine and session configuration."""

fastapi_struct-0.1.0/src/create_fastapi_app/templates/basic/app/dependencies.py

@@ -0,0 +1 @@
+"""Shared FastAPI dependencies."""

fastapi_struct-0.1.0/src/create_fastapi_app/templates/basic/app/main.py

@@ -0,0 +1,19 @@
+from fastapi import FastAPI
+from app.core.config import settings
+from app.routers.health import router as health_router
+from app.routers.users import router as users_router
+
+app = FastAPI(
+    title=settings.PROJECT_NAME,
+    version="0.1.0",
+)
+
+app.include_router(health_router)
+app.include_router(users_router)
+
+
+@app.get("/", tags=["Root"])
+async def root():
+    return {
+        "message": f"Welcome to {settings.PROJECT_NAME}"
+    }

fastapi_struct-0.1.0/src/create_fastapi_app/templates/basic/app/models/__init__.py

@@ -0,0 +1 @@
+"""Database models."""

fastapi_struct-0.1.0/src/create_fastapi_app/templates/basic/app/routers/health.py

@@ -0,0 +1,8 @@
+from fastapi import APIRouter
+
+router = APIRouter(tags=["Health"])
+
+
+@router.get("/health")
+async def health():
+    return {"status": "ok"}

fastapi_struct-0.1.0/src/create_fastapi_app/templates/basic/app/routers/users.py

@@ -0,0 +1,33 @@
+from fastapi import APIRouter, HTTPException, status
+from app.schemas.user import UserCreate, UserResponse
+
+router = APIRouter(prefix="/users", tags=["Users"])
+
+_users: dict[int, dict] = {}
+_next_id = 1
+
+
+@router.post(
+    "/",
+    response_model=UserResponse,
+    status_code=status.HTTP_201_CREATED,
+)
+async def create_user(payload: UserCreate):
+    global _next_id
+    user = {"id": _next_id, **payload.model_dump()}
+    _users[_next_id] = user
+    _next_id += 1
+    return user
+
+
+@router.get("/", response_model=list[UserResponse])
+async def list_users():
+    return list(_users.values())
+
+
+@router.get("/{user_id}", response_model=UserResponse)
+async def get_user(user_id: int):
+    user = _users.get(user_id)
+    if user is None:
+        raise HTTPException(404, "User not found")
+    return user

fastapi_struct-0.1.0/src/create_fastapi_app/templates/basic/app/schemas/user.py

@@ -0,0 +1,14 @@
+from pydantic import BaseModel, ConfigDict, EmailStr, Field
+
+
+class UserCreate(BaseModel):
+    name: str = Field(min_length=1, max_length=100)
+    email: EmailStr
+
+
+class UserResponse(BaseModel):
+    id: int
+    name: str
+    email: EmailStr
+
+    model_config = ConfigDict(from_attributes=True)

fastapi_struct-0.1.0/src/create_fastapi_app/templates/basic/app/services/__init__.py

@@ -0,0 +1 @@
+"""Business logic services."""

fastapi_struct-0.1.0/src/create_fastapi_app/templates/basic/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "my-api"
+version = "0.1.0"
+description = "A generated FastAPI application"
+requires-python = ">=3.10"
+dependencies = [
+    "fastapi>=0.115",
+    "uvicorn[standard]>=0.30",
+    "pydantic-settings>=2.0",
+    "email-validator>=2.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "httpx>=0.27",
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["."]
+testpaths = ["tests"]

fastapi_struct-0.1.0/src/create_fastapi_app/templates/basic/tests/test_main.py

@@ -0,0 +1,15 @@
+from fastapi.testclient import TestClient
+from app.main import app
+
+client = TestClient(app)
+
+
+def test_root():
+    response = client.get("/")
+    assert response.status_code == 200
+
+
+def test_health():
+    response = client.get("/health")
+    assert response.status_code == 200
+    assert response.json() == {"status": "ok"}

fastapi_struct-0.1.0/src/fastapi_struct.egg-info/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: fastapi-struct
+Version: 0.1.0
+Summary: CLI tool to generate standard folder structure for FastAPI applications.
+License-Expression: MIT
+Keywords: fastapi,project-structure,boilerplate,scaffold,cli,template,folder-structure
+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
+
+# fastapi-struct
+
+CLI tool to generate standard, production-ready folder structures for FastAPI applications.
+
+## Usage
+
+### Instant with uvx (no installation needed)
+```bash
+uvx fastapi-struct my-api
+```
+Or in the current folder:
+```bash
+uvx fastapi-struct .
+```
+
+### Or install via pip
+```bash
+pip install fastapi-struct
+fastapi-struct my-api
+```
+*(You can also use `create-fastapi-app my-api`)*
+
+## Generated Project Next Steps
+
+```powershell
+cd my-api
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip install -e ".[dev]"
+python -m uvicorn app.main:app --reload
+```
+
+Interactive API documentation will be available at:
+http://127.0.0.1:8000/docs

fastapi_struct-0.1.0/src/fastapi_struct.egg-info/SOURCES.txt

@@ -0,0 +1,32 @@
+MANIFEST.in
+README.md
+pyproject.toml
+src/create_fastapi_app/__init__.py
+src/create_fastapi_app/cli.py
+src/create_fastapi_app/generator.py
+src/create_fastapi_app/templates/basic/.env.example
+src/create_fastapi_app/templates/basic/.gitignore
+src/create_fastapi_app/templates/basic/README.md
+src/create_fastapi_app/templates/basic/pyproject.toml
+src/create_fastapi_app/templates/basic/app/__init__.py
+src/create_fastapi_app/templates/basic/app/dependencies.py
+src/create_fastapi_app/templates/basic/app/main.py
+src/create_fastapi_app/templates/basic/app/core/__init__.py
+src/create_fastapi_app/templates/basic/app/core/config.py
+src/create_fastapi_app/templates/basic/app/db/__init__.py
+src/create_fastapi_app/templates/basic/app/db/database.py
+src/create_fastapi_app/templates/basic/app/models/__init__.py
+src/create_fastapi_app/templates/basic/app/routers/__init__.py
+src/create_fastapi_app/templates/basic/app/routers/health.py
+src/create_fastapi_app/templates/basic/app/routers/users.py
+src/create_fastapi_app/templates/basic/app/schemas/__init__.py
+src/create_fastapi_app/templates/basic/app/schemas/user.py
+src/create_fastapi_app/templates/basic/app/services/__init__.py
+src/create_fastapi_app/templates/basic/tests/__init__.py
+src/create_fastapi_app/templates/basic/tests/test_main.py
+src/fastapi_struct.egg-info/PKG-INFO
+src/fastapi_struct.egg-info/SOURCES.txt
+src/fastapi_struct.egg-info/dependency_links.txt
+src/fastapi_struct.egg-info/entry_points.txt
+src/fastapi_struct.egg-info/top_level.txt
+tests/test_generator.py

fastapi_struct-0.1.0/src/fastapi_struct.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fastapi_struct-0.1.0/src/fastapi_struct.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+create-fastapi-app = create_fastapi_app.cli:main
+fastapi-struct = create_fastapi_app.cli:main

fastapi_struct-0.1.0/src/fastapi_struct.egg-info/top_level.txt

@@ -0,0 +1 @@
+create_fastapi_app

fastapi_struct-0.1.0/tests/test_generator.py

@@ -0,0 +1,29 @@
+import pytest
+from pathlib import Path
+from create_fastapi_app.generator import create_project
+
+
+def test_create_project_success(tmp_path, monkeypatch):
+    monkeypatch.chdir(tmp_path)
+    project_path = create_project("test_service")
+    assert project_path.exists()
+    assert (project_path / "pyproject.toml").exists()
+    assert (project_path / "app" / "main.py").exists()
+    assert (project_path / ".env.example").exists()
+    assert (project_path / ".gitignore").exists()
+
+    config = (project_path / "pyproject.toml").read_text(encoding="utf-8")
+    assert 'name = "test-service"' in config
+
+
+def test_create_project_invalid_name(tmp_path, monkeypatch):
+    monkeypatch.chdir(tmp_path)
+    with pytest.raises(ValueError):
+        create_project("123invalid")
+
+
+def test_create_project_already_exists(tmp_path, monkeypatch):
+    monkeypatch.chdir(tmp_path)
+    (tmp_path / "existing_app").mkdir()
+    with pytest.raises(FileExistsError):
+        create_project("existing_app")