FastAPI-fastkit 1.0.1__py3-none-any.whl → 1.0.2__py3-none-any.whl

fastapi_fastkit/fastapi_project_template/fastapi-async-crud/src/core/config.py-tpl

@@ -1,64 +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
+# --------------------------------------------------------------------------
+# 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

fastapi_fastkit/fastapi_project_template/fastapi-async-crud/src/crud/items.py-tpl

@@ -1,21 +1,21 @@
-# --------------------------------------------------------------------------
-# Item CRUD method module
-# --------------------------------------------------------------------------
-import json
-import os
-from typing import List
-
-import aiofiles  # type: ignore
-
-MOCK_FILE = os.path.join(os.path.dirname(__file__), "../mocks/mock_items.json")
-
-
-async def read_items():
-    async with aiofiles.open(MOCK_FILE, mode="r") as file:
-        contents = await file.read()
-        return json.loads(contents)
-
-
-async def write_items(items: List[dict]):
-    async with aiofiles.open(MOCK_FILE, mode="w") as file:
-        await file.write(json.dumps(items, indent=2))
+# --------------------------------------------------------------------------
+# Item CRUD method module
+# --------------------------------------------------------------------------
+import json
+import os
+from typing import List
+
+import aiofiles  # type: ignore
+
+MOCK_FILE = os.path.join(os.path.dirname(__file__), "../mocks/mock_items.json")
+
+
+async def read_items():
+    async with aiofiles.open(MOCK_FILE, mode="r") as file:
+        contents = await file.read()
+        return json.loads(contents)
+
+
+async def write_items(items: List[dict]):
+    async with aiofiles.open(MOCK_FILE, mode="w") as file:
+        await file.write(json.dumps(items, indent=2))

fastapi_fastkit/fastapi_project_template/fastapi-async-crud/src/main.py-tpl

@@ -1,26 +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)
+# --------------------------------------------------------------------------
+# 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)

fastapi_fastkit/fastapi_project_template/fastapi-async-crud/src/mocks/mock_items.json-tpl

@@ -1,8 +1,8 @@
-[
-  {
-    "id": 1,
-    "name": "Test Item 1",
-    "price": 20.0,
-    "category": "test"
-  }
-]
+[
+  {
+    "id": 1,
+    "name": "Test Item 1",
+    "price": 20.0,
+    "category": "test"
+  }
+]

fastapi_fastkit/fastapi_project_template/fastapi-async-crud/src/schemas/items.py-tpl

@@ -1,22 +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)
+# --------------------------------------------------------------------------
+# 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)

fastapi_fastkit/fastapi_project_template/fastapi-async-crud/tests/conftest.py-tpl

@@ -1,42 +1,42 @@
-# --------------------------------------------------------------------------
-# pytest runtime configuration module
-# --------------------------------------------------------------------------
-import asyncio
-import os
-import typing
-from pathlib import Path
-
-import pytest
-import pytest_asyncio
-from httpx import ASGITransport, AsyncClient
-
-from src.main import app
-
-MOCK_PATH = os.path.join(os.path.dirname(__file__), "../src/mocks/mock_items.json")
-
-
-@pytest.fixture(scope="session")
-def event_loop(request) -> typing.Generator:
-    loop = asyncio.get_event_loop()
-    yield loop
-    loop.close()
-
-
-@pytest_asyncio.fixture(scope="function", autouse=True)
-def mock_data_reset():
-    # Back up original data into memory
-    mock_path = Path(__file__).parent.parent / "src/mocks/mock_items.json"
-    original_data = mock_path.read_text()
-
-    yield
-
-    # After test, restore original data
-    mock_path.write_text(original_data)
-
-
-@pytest_asyncio.fixture(scope="module")
-async def client():
-    async with AsyncClient(
-        transport=ASGITransport(app=app), base_url="http://test"
-    ) as ac:
-        yield ac
+# --------------------------------------------------------------------------
+# pytest runtime configuration module
+# --------------------------------------------------------------------------
+import asyncio
+import os
+import typing
+from pathlib import Path
+
+import pytest
+import pytest_asyncio
+from httpx import ASGITransport, AsyncClient
+
+from src.main import app
+
+MOCK_PATH = os.path.join(os.path.dirname(__file__), "../src/mocks/mock_items.json")
+
+
+@pytest.fixture(scope="session")
+def event_loop(request) -> typing.Generator:
+    loop = asyncio.get_event_loop()
+    yield loop
+    loop.close()
+
+
+@pytest_asyncio.fixture(scope="function", autouse=True)
+def mock_data_reset():
+    # Back up original data into memory
+    mock_path = Path(__file__).parent.parent / "src/mocks/mock_items.json"
+    original_data = mock_path.read_text()
+
+    yield
+
+    # After test, restore original data
+    mock_path.write_text(original_data)
+
+
+@pytest_asyncio.fixture(scope="module")
+async def client():
+    async with AsyncClient(
+        transport=ASGITransport(app=app), base_url="http://test"
+    ) as ac:
+        yield ac

fastapi_fastkit/fastapi_project_template/fastapi-async-crud/tests/test_items.py-tpl

@@ -1,48 +1,48 @@
-# --------------------------------------------------------------------------
-# Item endpoint testcases (Async version)
-# --------------------------------------------------------------------------
-import pytest
-
-
-@pytest.mark.asyncio
-async def test_read_all_items(client):
-    response = await client.get("/items")
-    assert response.status_code == 200
-    assert len(response.json()) == 1
-
-
-@pytest.mark.asyncio
-async def test_read_item_success(client):
-    response = await client.get("/items/1")
-    assert response.status_code == 200
-    assert response.json()["name"] == "Test Item 1"
-
-
-@pytest.mark.asyncio
-async def test_read_item_not_found(client):
-    response = await client.get("/items/999")
-    assert response.status_code == 404
-
-
-@pytest.mark.asyncio
-async def test_create_item(client):
-    new_item = {"name": "New Item", "price": 30.0, "category": "new"}
-    response = await client.post("/items", json=new_item)
-    assert response.status_code == 201
-    assert response.json()["id"] == 2
-
-
-@pytest.mark.asyncio
-async def test_update_item(client):
-    updated_data = {"name": "Updated Item", "price": 15.0, "category": "updated"}
-    response = await client.put("/items/1", json=updated_data)
-    assert response.status_code == 200
-    assert response.json()["name"] == "Updated Item"
-
-
-@pytest.mark.asyncio
-async def test_delete_item(client):
-    response = await client.delete("/items/1")
-    assert response.status_code == 200
-    response = await client.get("/items/1")
-    assert response.status_code == 404
+# --------------------------------------------------------------------------
+# Item endpoint testcases (Async version)
+# --------------------------------------------------------------------------
+import pytest
+
+
+@pytest.mark.asyncio
+async def test_read_all_items(client):
+    response = await client.get("/items")
+    assert response.status_code == 200
+    assert len(response.json()) == 1
+
+
+@pytest.mark.asyncio
+async def test_read_item_success(client):
+    response = await client.get("/items/1")
+    assert response.status_code == 200
+    assert response.json()["name"] == "Test Item 1"
+
+
+@pytest.mark.asyncio
+async def test_read_item_not_found(client):
+    response = await client.get("/items/999")
+    assert response.status_code == 404
+
+
+@pytest.mark.asyncio
+async def test_create_item(client):
+    new_item = {"name": "New Item", "price": 30.0, "category": "new"}
+    response = await client.post("/items", json=new_item)
+    assert response.status_code == 201
+    assert response.json()["id"] == 2
+
+
+@pytest.mark.asyncio
+async def test_update_item(client):
+    updated_data = {"name": "Updated Item", "price": 15.0, "category": "updated"}
+    response = await client.put("/items/1", json=updated_data)
+    assert response.status_code == 200
+    assert response.json()["name"] == "Updated Item"
+
+
+@pytest.mark.asyncio
+async def test_delete_item(client):
+    response = await client.delete("/items/1")
+    assert response.status_code == 200
+    response = await client.get("/items/1")
+    assert response.status_code == 404

fastapi_fastkit/fastapi_project_template/fastapi-custom-response/.env-tpl

@@ -1 +1 @@
-SECRET_KEY=changethis
+SECRET_KEY=changethis