fastapi-struct 0.1.0__py3-none-any.whl

create_fastapi_app/__init__.py

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

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()

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

create_fastapi_app/templates/basic/.env.example

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

create_fastapi_app/templates/basic/.gitignore

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

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

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()

create_fastapi_app/templates/basic/app/db/database.py

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

create_fastapi_app/templates/basic/app/dependencies.py

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

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}"
+    }

create_fastapi_app/templates/basic/app/models/__init__.py

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

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"}

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

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)

create_fastapi_app/templates/basic/app/services/__init__.py

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

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"]

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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,28 @@
+create_fastapi_app/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+create_fastapi_app/cli.py,sha256=gJpQzIzco1JV4_8YTTlijhuZF_7e_o2MnIs7MdpQnS8,1155
+create_fastapi_app/generator.py,sha256=dN6ibM_ds5H7x8R7lX_BcNg5kEgEERwy0uPDJw2EQK0,1046
+create_fastapi_app/templates/basic/.env.example,sha256=tVjHTUdDIkO_7nA1Pc31V25rIJP09OIC43qdjlVcEQs,41
+create_fastapi_app/templates/basic/.gitignore,sha256=FAr3KyxAtp25Pdxo7PInoWlbSiSLSC1yMl0Iq2oKeew,61
+create_fastapi_app/templates/basic/README.md,sha256=AjWuTg8WUsZ9j1BoOX-ijbsjxFDVZN9_zdG0CwCYrYE,277
+create_fastapi_app/templates/basic/pyproject.toml,sha256=RgqohpE4F11fgd7CoaOgfO8L-yxj4XvYZ3BahH_OgGE,419
+create_fastapi_app/templates/basic/app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+create_fastapi_app/templates/basic/app/dependencies.py,sha256=5oj7FKbc3itgd35Umc7PKqtvgQMDkj1SZcPiMzEGlmg,36
+create_fastapi_app/templates/basic/app/main.py,sha256=0S29EuP2x8XPbJiMsJEZwjUPfkjhw32WlcWu2JS6Kzg,457
+create_fastapi_app/templates/basic/app/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+create_fastapi_app/templates/basic/app/core/config.py,sha256=V8ct81YdTlSJIJXeaM8jbX9fyNm7J413Ld6gKX4NSyw,292
+create_fastapi_app/templates/basic/app/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+create_fastapi_app/templates/basic/app/db/database.py,sha256=xJH6ksVoyohKuUd7jws_PO0yUi8fpNIS2YB1InrS_tk,50
+create_fastapi_app/templates/basic/app/models/__init__.py,sha256=IGHnLLANQKYVbo3Ga1Zkw_Cvc6dFXlsRGg-vegvLXjo,24
+create_fastapi_app/templates/basic/app/routers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+create_fastapi_app/templates/basic/app/routers/health.py,sha256=oJz-ESqnuhhR-3Bn1qkfcuAKdmWnpdQT6SHZvnd0p7I,148
+create_fastapi_app/templates/basic/app/routers/users.py,sha256=69qguaqhG1glWC00qLqs2tIYtVgCqAQFdQkXa1XWQCs,836
+create_fastapi_app/templates/basic/app/schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+create_fastapi_app/templates/basic/app/schemas/user.py,sha256=W9yWUGbuswmXpV0yCL1lnUojJKbsuvNCZ7qpPU3MwtE,309
+create_fastapi_app/templates/basic/app/services/__init__.py,sha256=6KBTji_ZFafSQqlG1o7MQOZz1cY6iM6McZMrUMdkKfQ,32
+create_fastapi_app/templates/basic/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+create_fastapi_app/templates/basic/tests/test_main.py,sha256=C6lcq38LlTXyEf6iOT67Xis2N7YbmKjQpYAL3h9rJjw,341
+fastapi_struct-0.1.0.dist-info/METADATA,sha256=OV81NMI7djLjLXtNb2mEkWxyTSsesJiQcj0bezqhAvM,1216
+fastapi_struct-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+fastapi_struct-0.1.0.dist-info/entry_points.txt,sha256=sZ3DCmuI2f5mPp4G0QahddlzOm_9MnahT-tHG_awyXw,112
+fastapi_struct-0.1.0.dist-info/top_level.txt,sha256=m9YzseithBld60oU2cROBGqFlqX2Zobup82fI3qOVhg,19
+fastapi_struct-0.1.0.dist-info/RECORD,,

fastapi_struct-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fastapi_struct-0.1.0.dist-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.dist-info/top_level.txt

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