[TEMPLATE] add fastapi-default template

bnbong · bnbong · commit eaf88cbd7ef3 · 2025-02-20T18:14:37.000+09:00
diff --git a/src/fastapi_fastkit/backend.py b/src/fastapi_fastkit/backend.py
@@ -89,7 +89,7 @@ def inject_project_metadata(
     author_email: str,
     description: str,
 ) -> None:
-    # TODO : add main.py location at parameter
+    # TODO : add main.py location at parameter & find settings.py, config.py, etc and inject project name init
     """Inject project metadata."""
     try:
         main_py_path = os.path.join(target_dir, "main.py")
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/.env-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/.env-tpl
@@ -0,0 +1 @@
+SECRET_KEY=changethis
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/.gitignore-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/.gitignore-tpl
@@ -0,0 +1,30 @@
+.idea
+.ipynb_checkpoints
+.mypy_cache
+.vscode
+__pycache__
+.pytest_cache
+htmlcov
+dist
+site
+.coverage*
+coverage.xml
+.netlify
+test.db
+log.txt
+Pipfile.lock
+env3.*
+env
+docs_build
+site_build
+venv
+docs.zip
+archive.zip
+
+# vim temporary files
+*~
+.*.sw?
+.cache
+
+# macOS
+.DS_Store
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/README.md-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/README.md-tpl
@@ -0,0 +1,25 @@
+# Simple FastAPI Project
+
+Simple CRUD API application using FastAPI
+
+## Features
+
+- Item Creation, Read, Update, Delete (CRUD) functionality
+- Automatic OpenAPI documentation generation (Swagger UI, ReDoc)
+- Test environment with mock data
+
+## Stack
+
+- Python 3.12+
+- FastAPI + uvicorn
+- pydantic & pydantic-settings
+- pytest
+- mypy + black + isort
+
+## How to run
+
+at venv, run command below:
+
+```bash
+$ uvicorn src.main:app --reload
+```
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/requirements.txt-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/requirements.txt-tpl
@@ -0,0 +1,34 @@
+annotated-types==0.7.0
+anyio==4.8.0
+black==25.1.0
+certifi==2025.1.31
+click==8.1.8
+fastapi==0.115.8
+h11==0.14.0
+httpcore==1.0.7
+httptools==0.6.4
+httpx==0.28.1
+idna==3.10
+iniconfig==2.0.0
+isort==6.0.0
+mypy==1.15.0
+mypy-extensions==1.0.0
+packaging==24.2
+pathspec==0.12.1
+platformdirs==4.3.6
+pluggy==1.5.0
+pydantic==2.10.6
+pydantic-settings==2.7.1
+pydantic_core==2.27.2
+pytest==8.3.4
+python-dotenv==1.0.1
+PyYAML==6.0.2
+setuptools==75.8.0
+sniffio==1.3.1
+SQLAlchemy==2.0.38
+starlette==0.45.3
+typing_extensions==4.12.2
+uvicorn==0.34.0
+uvloop==0.21.0
+watchfiles==1.0.4
+websockets==15.0
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/scripts/format.sh-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/scripts/format.sh-tpl
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -x
+
+black .
+isort .
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/scripts/lint.sh-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/scripts/lint.sh-tpl
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -x
+
+black . --check
+mypy src
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/scripts/test.sh-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/scripts/test.sh-tpl
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+set -e
+set -x
+
+pytest
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/setup.cfg-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/setup.cfg-tpl
@@ -0,0 +1,13 @@
+[mypy]
+warn_unused_configs = true
+ignore_missing_imports = true
+
+[isort]
+profile = black
+line_length=100
+virtual_env=venv
+
+[tool:pytest]
+pythonpath = src
+testpaths = tests
+python_files = test_*.py
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/setup.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/setup.py-tpl
@@ -0,0 +1,22 @@
+# --------------------------------------------------------------------------
+# package setup module
+# --------------------------------------------------------------------------
+from setuptools import find_packages, setup
+
+install_requires: list[str] = [
+    "fastapi",
+    "pydantic",
+    "pydantic-settings",
+    "python-dotenv",
+]
+
+setup(
+    name="<project_name>",
+    description="<description>",
+    author="<author>",
+    author_email=f"<author_email>",
+    packages=find_packages(where="src"),
+    use_scm_version=True,
+    requires=["python (>=3.12)"],
+    install_requires=install_requires,
+)
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/__init__.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/__init__.py-tpl
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/api/__init__.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/api/__init__.py-tpl
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/api/api.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/api/api.py-tpl
@@ -0,0 +1,9 @@
+# --------------------------------------------------------------------------
+# API router connector module
+# --------------------------------------------------------------------------
+from fastapi import APIRouter
+
+from src.api.routes import items
+
+api_router = APIRouter()
+api_router.include_router(items.router)
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/api/routes/__init__.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/api/routes/__init__.py-tpl
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/api/routes/items.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/api/routes/items.py-tpl
@@ -0,0 +1,57 @@
+# --------------------------------------------------------------------------
+# Item CRUD Endpoint
+# --------------------------------------------------------------------------
+from typing import List
+
+from fastapi import APIRouter, HTTPException
+
+from src.crud.items import read_items, write_items
+from src.schemas.items import ItemCreate, ItemResponse
+
+router = APIRouter()
+
+
+@router.get("/items", response_model=List[ItemResponse])
+async def read_all_items():
+    return read_items()
+
+
+@router.get("/items/{item_id}", response_model=ItemResponse)
+async def read_item(item_id: int):
+    items = read_items()
+    item = next((i for i in items if i["id"] == item_id), None)
+    if not item:
+        raise HTTPException(status_code=404, detail="Item not found")
+    return item
+
+
+@router.post("/items", response_model=ItemResponse, status_code=201)
+async def create_item(item: ItemCreate):
+    items = read_items()
+    new_id = max(i["id"] for i in items) + 1 if items else 1
+    new_item = {**item.model_dump(), "id": new_id}
+    items.append(new_item)
+    write_items(items)
+    return new_item
+
+
+@router.put("/items/{item_id}", response_model=ItemResponse)
+async def update_item(item_id: int, item: ItemCreate):
+    items = read_items()
+    index = next((i for i, v in enumerate(items) if v["id"] == item_id), None)
+    if index is None:
+        raise HTTPException(status_code=404, detail="Item not found")
+    updated_item = {**item.model_dump(), "id": item_id}
+    items[index] = updated_item
+    write_items(items)
+    return updated_item
+
+
+@router.delete("/items/{item_id}")
+async def delete_item(item_id: int):
+    items = read_items()
+    new_items = [i for i in items if i["id"] != item_id]
+    if len(new_items) == len(items):
+        raise HTTPException(status_code=404, detail="Item not found")
+    write_items(new_items)
+    return {"message": "Item deleted successfully"}
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/core/config.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/core/config.py-tpl
@@ -0,0 +1,64 @@
+# --------------------------------------------------------------------------
+# Configuration module
+# --------------------------------------------------------------------------
+import secrets
+import warnings
+from typing import Annotated, Any, Literal
+
+from pydantic import AnyUrl, BeforeValidator, computed_field, model_validator
+from pydantic_settings import BaseSettings, SettingsConfigDict
+from typing_extensions import Self
+
+
+def parse_cors(v: Any) -> list[str] | str:
+    if isinstance(v, str) and not v.startswith("["):
+        return [i.strip() for i in v.split(",")]
+    elif isinstance(v, list | str):
+        return v
+    raise ValueError(v)
+
+
+class Settings(BaseSettings):
+    model_config = SettingsConfigDict(
+        env_file=".env",
+        env_ignore_empty=True,
+        extra="ignore",
+    )
+
+    SECRET_KEY: str = secrets.token_urlsafe(32)
+    ENVIRONMENT: Literal["development", "production"] = "development"
+
+    CLIENT_ORIGIN: str = ""
+
+    BACKEND_CORS_ORIGINS: Annotated[list[AnyUrl] | str, BeforeValidator(parse_cors)] = (
+        []
+    )
+
+    @computed_field  # type: ignore[prop-decorator]
+    @property
+    def all_cors_origins(self) -> list[str]:
+        return [str(origin).rstrip("/") for origin in self.BACKEND_CORS_ORIGINS] + [
+            self.CLIENT_ORIGIN
+        ]
+
+    PROJECT_NAME: str = "<project_name>"
+
+    def _check_default_secret(self, var_name: str, value: str | None) -> None:
+        if value == "changethis":
+            message = (
+                f'The value of {var_name} is "changethis", '
+                "for security, please change it, at least for deployments."
+            )
+            if self.ENVIRONMENT == "development":
+                warnings.warn(message, stacklevel=1)
+            else:
+                raise ValueError(message)
+
+    @model_validator(mode="after")
+    def _enforce_non_default_secrets(self) -> Self:
+        self._check_default_secret("SECRET_KEY", self.SECRET_KEY)
+
+        return self
+
+
+settings = Settings()  # type: ignore
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/crud/__init__.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/crud/__init__.py-tpl
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/crud/items.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/crud/items.py-tpl
@@ -0,0 +1,18 @@
+# --------------------------------------------------------------------------
+# Item CRUD method module
+# --------------------------------------------------------------------------
+import json
+import os
+from typing import List
+
+MOCK_FILE = os.path.join(os.path.dirname(__file__), "../mocks/mock_items.json")
+
+
+def read_items():
+    with open(MOCK_FILE, "r") as file:
+        return json.load(file)
+
+
+def write_items(items: List[dict]):
+    with open(MOCK_FILE, "w") as file:
+        json.dump(items, file, indent=2)
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/main.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/main.py-tpl
@@ -0,0 +1,26 @@
+# --------------------------------------------------------------------------
+# Main server application module
+# --------------------------------------------------------------------------
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI
+from starlette.middleware.cors import CORSMiddleware
+
+from src.api.api import api_router
+from src.core.config import settings
+
+app = FastAPI(
+    title=settings.PROJECT_NAME,
+)
+
+if settings.all_cors_origins:
+    app.add_middleware(
+        CORSMiddleware,
+        allow_origins=settings.all_cors_origins,
+        allow_credentials=True,
+        allow_methods=["*"],
+        allow_headers=["*"],
+    )
+
+
+app.include_router(api_router)
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/mocks/__init__.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/mocks/__init__.py-tpl
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/mocks/mock_items.json-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/mocks/mock_items.json-tpl
@@ -0,0 +1,8 @@
+[
+  {
+    "id": 2,
+    "name": "Test Item 2",
+    "price": 20.0,
+    "category": "test"
+  }
+]
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/schemas/items.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/src/schemas/items.py-tpl
@@ -0,0 +1,22 @@
+# --------------------------------------------------------------------------
+# Item schema module
+# --------------------------------------------------------------------------
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict
+
+
+class ItemBase(BaseModel):
+    name: str
+    description: Optional[str] = None
+    price: float
+    category: str
+
+
+class ItemCreate(ItemBase):
+    pass
+
+
+class ItemResponse(ItemBase):
+    id: int
+    model_config = ConfigDict(from_attributes=True)
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/tests/conftest.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/tests/conftest.py-tpl
@@ -0,0 +1,15 @@
+# --------------------------------------------------------------------------
+# pytest runtime configuration module
+# --------------------------------------------------------------------------
+from collections.abc import Generator
+
+import pytest
+from fastapi.testclient import TestClient
+
+from src.main import app
+
+
+@pytest.fixture(scope="module")
+def client() -> Generator[TestClient, None, None]:
+    with TestClient(app) as c:
+        yield c
diff --git a/src/fastapi_fastkit/fastapi_project_template/fastapi-default/tests/test_items.py-tpl b/src/fastapi_fastkit/fastapi_project_template/fastapi-default/tests/test_items.py-tpl

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +#!/usr/bin/env bash
 +set -x
++
 +black .
 +isort .