fastapi-startkit 0.1.3__tar.gz → 0.13.1__tar.gz

fastapi_startkit-0.13.1/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.3
+Name: fastapi-startkit
+Version: 0.13.1
+Summary: Fastapi Starter kit components
+Author: Bedram Tamang
+Author-email: Bedram Tamang <tmgbedu@gmail.com>
+Requires-Dist: dotty-dict>=1.3.1
+Requires-Dist: pendulum>=3.1.0,<4.0.0
+Requires-Dist: inflection>=0.5.1
+Requires-Dist: requests>=2.32.5,<3.0.0
+Requires-Dist: cleo>=2.1.0,<3.0.0
+Requires-Dist: dotenv>=0.9.9
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: faker>=40.13.0 ; extra == 'database'
+Requires-Dist: sqlalchemy[asyncio]>=2.0.38 ; extra == 'database'
+Requires-Dist: fastapi[standard]>=0.124.4,<0.125.0 ; extra == 'fastapi'
+Requires-Dist: aiomysql>=0.2.0 ; extra == 'mysql'
+Requires-Dist: asyncpg>=0.29.0 ; extra == 'postgres'
+Requires-Dist: aiosqlite>=0.22.1 ; extra == 'sqlite'
+Requires-Dist: jinja2>=3.1 ; extra == 'vite'
+Requires-Python: >=3.12, <4.0
+Provides-Extra: database
+Provides-Extra: fastapi
+Provides-Extra: mysql
+Provides-Extra: postgres
+Provides-Extra: sqlite
+Provides-Extra: vite

fastapi_startkit-0.13.1/pyproject.toml

@@ -0,0 +1,61 @@
+[project]
+name = "fastapi-startkit"
+version = "0.13.1"
+description = "Fastapi Starter kit components"
+authors = [
+    {name = "Bedram Tamang", email = "tmgbedu@gmail.com"}
+]
+requires-python = ">=3.12,<4.0"
+dependencies = [
+    "dotty-dict>=1.3.1",
+    "pendulum (>=3.1.0,<4.0.0)",
+    "inflection>=0.5.1",
+    "requests (>=2.32.5,<3.0.0)",
+    "cleo>=2.1.0,<3.0.0",
+    "dotenv>=0.9.9",
+    "pydantic>=2.12.5",
+]
+
+[project.optional-dependencies]
+fastapi = [
+    "fastapi[standard] (>=0.124.4,<0.125.0)",
+]
+database = [
+    "faker>=40.13.0",
+    "sqlalchemy[asyncio]>=2.0.38",
+]
+
+sqlite = [
+    "aiosqlite>=0.22.1"
+]
+
+postgres = [
+    "asyncpg>=0.29.0",
+]
+
+mysql = [
+    "aiomysql>=0.2.0",
+]
+
+vite=[
+    "jinja2>=3.1",
+]
+
+[dependency-groups]
+dev = [
+    "dumpdie>=1.5.0",
+    "pytest>=9.0.3",
+    "pytest-asyncio>=1.3.0",
+    "twine>=6.2.0",
+]
+
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[build-system]
+requires = ["uv_build >= 0.10.10, <0.11.0"]
+build-backend = "uv_build"
+
+[tool.uv]
+-workspace = { members = ["application", "example/*"] }

fastapi_startkit-0.13.1/src/fastapi_startkit/application.py

@@ -0,0 +1,193 @@
+import os
+from pathlib import Path
+from typing import TYPE_CHECKING, Optional
+from typing import Type, Callable, Any, List, TypeVar, Generic
+
+from fastapi_startkit.providers.app_provider import AppProvider
+from .config import AppConfig
+from .configuration.providers import ConfigurationProvider
+from .container import Container
+from .environment.environment import LoadEnvironment
+
+if TYPE_CHECKING:
+    from fastapi import FastAPI, APIRouter
+    from starlette.middleware.base import BaseHTTPMiddleware
+
+from fastapi_startkit.exceptions import ExceptionHandler
+
+
+def app() -> 'Container':
+    return Container.instance()
+
+
+TConfig = TypeVar('TConfig', bound=AppConfig)
+
+class Application(Container, Generic[TConfig]):
+    DEFAULT_PROVIDERS = [
+        ConfigurationProvider,
+        AppProvider,
+    ]
+
+    def __init__(self, base_path: str = None, env=None, providers=None, config: Type[TConfig] | None = None, exception_handler: Type[ExceptionHandler] | None = None):
+        super().__init__()
+
+        self.base_path: str = base_path or os.getcwd()
+        self.env = env
+        self.providers = self.DEFAULT_PROVIDERS + (providers or [])
+        self.published_resources = {}
+        self.commands = []
+        self._config = config
+        self._config_instance: Optional[TConfig] = None
+        self._exception_handler_class = exception_handler or ExceptionHandler
+        self.exception_manager: ExceptionHandler
+
+        # Set global singleton
+        Container.set_instance(self)
+
+        self.configure_exception_handler()
+
+        # Boot application
+        self.load_environment()
+        self.configure_config()
+        self.configure_paths()
+        self.register_providers()
+
+        self._fastapi: Optional["FastAPI"] = None
+        self.load_providers()
+
+    def configure_exception_handler(self):
+        self.exception_manager: ExceptionHandler = self._exception_handler_class(application=self)
+        self.exception_manager.register()
+        self.exception_manager.install()
+        self.bind("exception_manager", self.exception_manager)
+
+    def register_providers(self):
+        providers = []
+        for provider_data in self.providers:
+            config = {}
+            if isinstance(provider_data, tuple):
+                provider_class, config = provider_data
+            else:
+                provider_class = provider_data
+
+            provider = provider_class(self, config=config)
+            provider.register()
+            providers.append(provider)
+
+        self.providers = providers
+        return self
+
+    def load_providers(self):
+        for provider in self.providers:
+            self.resolve(provider.boot)
+        return self
+
+    def use_fastapi(self, fastapi: "FastAPI"):
+        self._fastapi = fastapi
+        return self
+
+    def use_base_path(self, path: str):
+        return str(Path(self.base_path) / path)
+
+    def get(self, path: str, **kwargs) -> Callable:
+        return self.fastapi.get(path, **kwargs)
+
+    def post(self, path: str, **kwargs) -> Callable:
+        return self.fastapi.post(path, **kwargs)
+
+    def put(self, path: str, **kwargs) -> Callable:
+        return self.fastapi.put(path, **kwargs)
+
+    def delete(self, path: str, **kwargs) -> Callable:
+        return self.fastapi.delete(path, **kwargs)
+
+    def patch(self, path: str, **kwargs) -> Callable:
+        return self.fastapi.patch(path, **kwargs)
+
+    def options(self, path: str, **kwargs) -> Callable:
+        return self.fastapi.options(path, **kwargs)
+
+    def head(self, path: str, **kwargs) -> Callable:
+        return self._fastapi.head(path, **kwargs)
+
+    def trace(self, path: str, **kwargs) -> Callable:
+        return self._fastapi.trace(path, **kwargs)
+
+    # Include routers
+    def include_router(self, router: "APIRouter", **kwargs):
+        self.fastapi.include_router(router, **kwargs)
+        return self
+
+    # Add middleware
+    def add_middleware(self, middleware_class: Type['BaseHTTPMiddleware'], **options):
+        self._fastapi.add_middleware(middleware_class, **options)
+        return self
+
+    # Add event handlers (startup/shutdown)
+    def add_event_handler(self, event_type: str, func: Callable[..., Any]):
+        self.fastapi.add_event_handler(event_type, func)
+        return self
+
+    # Mount sub-apps
+    def mount(self, path: str, app_instance: "FastAPI", **kwargs):
+        self._fastapi.mount(path, app_instance, **kwargs)
+        return self
+
+    # Add custom exception handlers
+    def add_exception_handler(self, exc_class_or_status_code: Any, handler: Callable[..., Any]):
+        self._fastapi.add_exception_handler(exc_class_or_status_code, handler)
+        return self
+
+    @property
+    def fastapi(self) -> "FastAPI":
+        if self._fastapi is None:
+            try:
+                from fastapi import FastAPI
+            except ImportError:
+                raise RuntimeError(
+                    "FastAPI is not installed. Install it with: pip install fastapi"
+                )
+            self._fastapi = FastAPI()
+        # Making the type hint work
+        assert self._fastapi is not None
+        return self._fastapi
+
+    def __call__(self, *args, **kwargs):
+        return self.fastapi
+
+    def load_environment(self):
+        LoadEnvironment(environment=self.env, base_path=self.base_path)
+
+    def is_debug(self) -> bool:
+        return hasattr(self, '_config_instance') and self._config_instance is not None and getattr(self._config_instance, 'debug', False)
+
+    def configure_config(self):
+        if self._config is not None:
+            self._config_instance = self._config()
+
+    @property
+    def config(self) -> TConfig:
+        if self._config_instance is None:
+            raise RuntimeError("Config is not set")
+        return self._config_instance
+
+    def configure_paths(self):
+        self.bind('config.location', os.path.join(self.base_path, "config"))
+
+    def use_config_path(self, path: str = None):
+        self.bind('config.location', path)
+
+        return self
+
+    def use_storage_path(self, path: str = None):
+        self.bind('storage.location', path)
+
+        return self
+
+    def add_commands(self, commands: List):
+        self.commands.extend(commands)
+
+    def handle_command(self):
+        from fastapi_startkit.console import ConsoleApplication
+
+        ConsoleApplication(self).handle()

fastapi_startkit-0.13.1/src/fastapi_startkit/carbon/__init__.py

@@ -0,0 +1 @@
+from .carbon import Carbon

fastapi_startkit-0.13.1/src/fastapi_startkit/carbon/carbon.py

@@ -0,0 +1,3 @@
+import pendulum
+
+Carbon = pendulum.DateTime

fastapi_startkit-0.13.1/src/fastapi_startkit/collection/__init__.py

@@ -0,0 +1 @@
+from .collection import Collection