fastapi-sdk 0.1.0__tar.gz

fastapi_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.2
+Name: fastapi-sdk
+Version: 0.1.0
+Summary: Utilities for FastAPI projects.
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi[standard]>=0.115.11
+Requires-Dist: odmantic>=1.0.2
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pydantic-settings>=2.8.1
+Requires-Dist: pytest>=8.3.5
+Requires-Dist: pytest-asyncio>=0.25.3
+Requires-Dist: shortuuid>=1.0.13
+
+# FastAPI SDK
+
+## Run tests
+
+```bash
+uv sync
+pytest
+```
+
+## Update requirements
+
+You can add new requirements by using UV:
+
+```bash
+uv add module_name
+```
+
+Then update the requirements.txt:
+
+```bash
+uv pip compile pyproject.toml -o requirements.txt
+```

fastapi_sdk-0.1.0/README.md

@@ -0,0 +1,22 @@
+# FastAPI SDK
+
+## Run tests
+
+```bash
+uv sync
+pytest
+```
+
+## Update requirements
+
+You can add new requirements by using UV:
+
+```bash
+uv add module_name
+```
+
+Then update the requirements.txt:
+
+```bash
+uv pip compile pyproject.toml -o requirements.txt
+```

fastapi_sdk-0.1.0/fastapi_sdk/controller.py

@@ -0,0 +1,109 @@
+"""Controller module for crud operations."""
+
+from datetime import UTC, datetime
+from typing import List, Optional, Type
+
+from odmantic import AIOEngine, Model
+from pydantic import BaseModel
+
+from fastapi_sdk.utils.schema import datetime_now_sec
+
+
+class Controller:
+    """Base controller class."""
+
+    model: Type[Model]
+    schema_create: Type[BaseModel]
+    schema_update: Type[BaseModel]
+    n_per_page: int = 10
+
+    def __init__(self, db_engine: AIOEngine):
+        """Initialize the controller."""
+        self.db_engine = db_engine
+
+    async def _create(self, **kwargs) -> BaseModel:
+        """Create a new model."""
+        data = self.schema_create(**kwargs)
+        model = self.model(**data.model_dump())
+        return await self.db_engine.save(model)
+
+    async def _update(self, uuid: str, data: dict) -> BaseModel:
+        """Update a model."""
+        model = await self._get(uuid)
+        data = self.schema_update(**data)
+        if model:
+            # Update the fields submitted
+            for field in data.model_dump(exclude_unset=True):
+                setattr(model, field, data.model_dump()[field])
+            model.updated_at = datetime_now_sec()
+            return await self.db_engine.save(model)
+        return None
+
+    async def _get(self, uuid: str) -> BaseModel:
+        """Get a model."""
+        return await self.db_engine.find_one(
+            self.model, self.model.uuid == uuid, self.model.deleted == False
+        )
+
+    async def _delete(self, uuid: str) -> BaseModel:
+        """Delete a model."""
+        model = await self._get(uuid)
+        if model:
+            model.deleted = True
+            return await self.db_engine.save(model)
+        return None
+
+    async def _list(
+        self,
+        page: int = 0,
+        query: Optional[List[dict]] = None,
+        order_by: Optional[dict] = None,
+    ) -> List[BaseModel]:
+        """List models."""
+        # Get the collection
+        collection_name = self.model.model_config[
+            "collection"
+        ] or self.model.__name__.lower().replace("model", "")
+        _collection = self.db_engine.database[collection_name]
+
+        # Create a pipeline for aggregation
+        _pipeline = []
+
+        # Filter out deleted models by default
+        # Example query: [{"due_date": {"$gte": start_date}}]
+        _query = {"deleted": False}
+        if query:
+            for q in query:
+                _query.update(q)
+
+        # Sorting, default by created_at
+        # Order by example: {"name": -1}, 1 ascending, -1 descending
+        _sort = order_by if order_by else {"created_at": -1}
+
+        # Add the pipeline stages
+        _pipeline.append({"$match": _query})
+        _pipeline.append({"$sort": _sort})
+
+        # Add pagination data
+        _pipeline.append({"$skip": (page - 1) * self.n_per_page if page > 0 else 0})
+        _pipeline.append({"$limit": self.n_per_page})
+
+        # Execute the aggregation
+        items = await _collection.aggregate(_pipeline).to_list(length=self.n_per_page)
+
+        # Count the total number of items
+        total = await _collection.count_documents(_query)
+
+        pages = total // self.n_per_page
+        if total % self.n_per_page > 0:
+            pages += 1
+
+        data = {
+            "items": [self.model.model_validate_doc(item) for item in items],
+            "total": total,
+            "size": len(items),
+            "page": page,
+            "pages": pages,
+        }
+
+        return data

fastapi_sdk-0.1.0/fastapi_sdk/utils/model.py

@@ -0,0 +1,28 @@
+"""Set of utilities to create and manage models."""
+
+import re
+from typing import Annotated
+
+import shortuuid
+from pydantic import StringConstraints
+
+
+class ShortUUID:
+    """Custom type for short UUIDs with trigram prefixes"""
+
+    @classmethod
+    def generate(cls, prefix: str) -> str:
+        """Generate a valid short UUID with a given trigram prefix"""
+        if not re.match(r"^[a-z]{3}$", prefix):
+            raise ValueError("Prefix must be exactly 3 lowercase letters")
+        return f"{prefix}_{shortuuid.uuid()[:10]}"
+
+    @classmethod
+    def validate(cls, value: str) -> str:
+        """Validate the short UUID format"""
+        if not re.match(r"^[a-z]{3}_[a-zA-Z0-9]{10}$", value):
+            raise ValueError("Invalid short UUID format")
+        return value
+
+
+ShortUUIDType = Annotated[str, StringConstraints(pattern=r"^[a-z]{3}_[a-zA-Z0-9]{10}$")]

fastapi_sdk-0.1.0/fastapi_sdk/utils/schema.py

@@ -0,0 +1,8 @@
+"""Schema utilities."""
+
+from datetime import UTC, datetime
+
+
+def datetime_now_sec():
+    """Return the current datetime with microseconds set to 0."""
+    return datetime.now(UTC).replace(microsecond=0)

fastapi_sdk-0.1.0/fastapi_sdk.egg-info/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.2
+Name: fastapi-sdk
+Version: 0.1.0
+Summary: Utilities for FastAPI projects.
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi[standard]>=0.115.11
+Requires-Dist: odmantic>=1.0.2
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pydantic-settings>=2.8.1
+Requires-Dist: pytest>=8.3.5
+Requires-Dist: pytest-asyncio>=0.25.3
+Requires-Dist: shortuuid>=1.0.13
+
+# FastAPI SDK
+
+## Run tests
+
+```bash
+uv sync
+pytest
+```
+
+## Update requirements
+
+You can add new requirements by using UV:
+
+```bash
+uv add module_name
+```
+
+Then update the requirements.txt:
+
+```bash
+uv pip compile pyproject.toml -o requirements.txt
+```

fastapi_sdk-0.1.0/fastapi_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+fastapi_sdk/controller.py
+fastapi_sdk.egg-info/PKG-INFO
+fastapi_sdk.egg-info/SOURCES.txt
+fastapi_sdk.egg-info/dependency_links.txt
+fastapi_sdk.egg-info/requires.txt
+fastapi_sdk.egg-info/top_level.txt
+fastapi_sdk/utils/model.py
+fastapi_sdk/utils/schema.py
+tests/test_controller.py

fastapi_sdk-0.1.0/fastapi_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fastapi_sdk-0.1.0/fastapi_sdk.egg-info/requires.txt

@@ -0,0 +1,7 @@
+fastapi[standard]>=0.115.11
+odmantic>=1.0.2
+pydantic>=2.10.6
+pydantic-settings>=2.8.1
+pytest>=8.3.5
+pytest-asyncio>=0.25.3
+shortuuid>=1.0.13

fastapi_sdk-0.1.0/fastapi_sdk.egg-info/top_level.txt

@@ -0,0 +1 @@
+fastapi_sdk

fastapi_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,15 @@
+[project]
+name = "fastapi-sdk"
+version = "0.1.0"
+description = "Utilities for FastAPI projects."
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "fastapi[standard]>=0.115.11",
+    "odmantic>=1.0.2",
+    "pydantic>=2.10.6",
+    "pydantic-settings>=2.8.1",
+    "pytest>=8.3.5",
+    "pytest-asyncio>=0.25.3",
+    "shortuuid>=1.0.13",
+]

fastapi_sdk-0.1.0/setup.cfg

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

fastapi_sdk-0.1.0/tests/test_controller.py

@@ -0,0 +1,67 @@
+"""Test controller."""
+
+import time
+from datetime import UTC
+
+import pytest
+from motor.core import AgnosticDatabase
+
+from tests.controllers import Account
+
+
+@pytest.mark.asyncio
+async def test_controller(db_engine: AgnosticDatabase):
+    """Test controller."""
+
+    # Create two accounts, one for crud test and one for listing
+    account_1 = await Account(db_engine).create(name="Account 1")
+    account_2 = await Account(db_engine).create(name="Account 2")
+
+    assert account_1.uuid
+    assert account_1.name == "Account 1"
+    assert account_1.created_at
+    assert account_1.updated_at
+
+    # Get account
+    account_1 = await Account(db_engine).get(uuid=account_1.uuid)
+    assert account_1
+
+    # Sleep for 1 seconds to test updated_at
+    time.sleep(1)
+
+    # Update account
+    account_1 = await Account(db_engine).update(
+        uuid=account_1.uuid, data={"name": "Account 1 Updated"}
+    )
+
+    assert account_1.name == "Account 1 Updated"
+    assert account_1.updated_at > account_1.created_at.replace(tzinfo=UTC)
+
+    # List accounts
+    accounts = await Account(db_engine).list()
+    assert len(accounts["items"]) == 2
+    assert accounts["total"] == 2
+    assert accounts["page"] == 0
+    assert accounts["pages"] == 1
+
+    # Delete account
+    account_1 = await Account(db_engine).delete(uuid=account_1.uuid)
+    assert account_1.deleted is True
+
+    # Get deleted account
+    deleted_account = await Account(db_engine).get(uuid=account_1.uuid)
+    assert deleted_account is None
+
+    # Update deleted account
+    deleted_account = await Account(db_engine).update(
+        uuid=account_1.uuid, data={"name": "Account 1 Updated"}
+    )
+    assert deleted_account is None
+
+    # List accounts with one deleted
+    accounts = await Account(db_engine).list()
+    assert len(accounts["items"]) == 1
+    assert accounts["items"][0].uuid == account_2.uuid
+    assert accounts["total"] == 1
+    assert accounts["page"] == 0
+    assert accounts["pages"] == 1