fastapi-startkit 0.13.7__tar.gz → 0.14.0__tar.gz

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fastapi-startkit
-Version: 0.13.7
+Version: 0.14.0
 Summary: Fastapi Starter kit components
 Author: Bedram Tamang
 Author-email: Bedram Tamang <tmgbedu@gmail.com>

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-startkit"
-version = "0.13.7"
+version = "0.14.0"
 description = "Fastapi Starter kit components"
 authors = [
     {name = "Bedram Tamang", email = "tmgbedu@gmail.com"}
@@ -46,10 +46,21 @@ dev = [
     "dumpdie>=1.5.0",
     "pytest>=9.0.3",
     "pytest-asyncio>=1.3.0",
+    "ruff>=0.9.0",
     "twine>=6.2.0",
 ]
 
 
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["F401"]
+fixable = ["F401"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
 

fastapi_startkit-0.14.0/src/fastapi_startkit/__init__.py

@@ -0,0 +1,4 @@
+from .application import Application
+from .configuration.config import Config
+
+__all__ = ["Application", "Config"]

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/src/fastapi_startkit/application.py

@@ -1,13 +1,13 @@
 import os
+from fastapi_startkit.providers.app_provider import AppProvider
 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
+from .environment.environment import Environment
 
 if TYPE_CHECKING:
     from fastapi import FastAPI, APIRouter
@@ -16,11 +16,12 @@ if TYPE_CHECKING:
 from fastapi_startkit.exceptions import ExceptionHandler
 
 
-def app() -> 'Container':
+def app() -> "Container":
     return Container.instance()
 
 
-TConfig = TypeVar('TConfig', bound=AppConfig)
+TConfig = TypeVar("TConfig", bound=AppConfig)
+
 
 class Application(Container, Generic[TConfig]):
     DEFAULT_PROVIDERS = [
@@ -28,10 +29,17 @@ class Application(Container, Generic[TConfig]):
         AppProvider,
     ]
 
-    def __init__(self, base_path: str = None, env=None, providers=None, config: Type[TConfig] | None = None, exception_handler: Type[ExceptionHandler] | None = None):
+    def __init__(
+        self,
+        base_path: str | Path = 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.base_path: Path = Path(base_path) if base_path else Path(os.getcwd())
         self.env = env
         self.providers = self.DEFAULT_PROVIDERS + (providers or [])
         self.published_resources = {}
@@ -47,7 +55,7 @@ class Application(Container, Generic[TConfig]):
         self.configure_exception_handler()
 
         # Boot application
-        self.load_environment()
+        self.resolve_environment()
         self.configure_config()
         self.configure_paths()
         self.register_providers()
@@ -55,8 +63,20 @@ class Application(Container, Generic[TConfig]):
         self._fastapi: Optional["FastAPI"] = None
         self.load_providers()
 
+    def set_environment(self, env: str):
+        self.env = env
+        return self
+
+    def load_environment(self):
+        """Reload environment variables for the current self.env."""
+        Environment.load_base(base_path=self.base_path)
+        Environment.load(self.env, base_path=self.base_path)
+        return self
+
     def configure_exception_handler(self):
-        self.exception_manager: ExceptionHandler = self._exception_handler_class(application=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)
@@ -67,6 +87,9 @@ class Application(Container, Generic[TConfig]):
             config = {}
             if isinstance(provider_data, tuple):
                 provider_class, config = provider_data
+
+                if callable(config):
+                    config = config()
             else:
                 provider_class = provider_data
 
@@ -87,7 +110,7 @@ class Application(Container, Generic[TConfig]):
         return self
 
     def use_base_path(self, path: str):
-        return str(Path(self.base_path) / path)
+        return self.base_path / path
 
     def get(self, path: str, **kwargs) -> Callable:
         return self.fastapi.get(path, **kwargs)
@@ -119,7 +142,7 @@ class Application(Container, Generic[TConfig]):
         return self
 
     # Add middleware
-    def add_middleware(self, middleware_class: Type['BaseHTTPMiddleware'], **options):
+    def add_middleware(self, middleware_class: Type["BaseHTTPMiddleware"], **options):
         self._fastapi.add_middleware(middleware_class, **options)
         return self
 
@@ -134,7 +157,9 @@ class Application(Container, Generic[TConfig]):
         return self
 
     # Add custom exception handlers
-    def add_exception_handler(self, exc_class_or_status_code: Any, handler: Callable[..., Any]):
+    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
 
@@ -155,11 +180,20 @@ class Application(Container, Generic[TConfig]):
     def __call__(self, *args, **kwargs):
         return self.fastapi
 
-    def load_environment(self):
-        LoadEnvironment(environment=self.env, base_path=self.base_path)
+    def resolve_environment(self):
+        self.env = Environment.resolve_environment(base_path=self.base_path, env=self.env)
+        Environment.load_base(base_path=self.base_path)
+        Environment.load(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)
+        return (
+            hasattr(self, "_config_instance")
+            and self._config_instance is not None
+            and getattr(self._config_instance, "debug", False)
+        )
+
+    def is_testing(self) -> bool:
+        return self.env == "testing"
 
     def configure_config(self):
         if self._config is not None:
@@ -172,15 +206,15 @@ class Application(Container, Generic[TConfig]):
         return self._config_instance
 
     def configure_paths(self):
-        self.bind('config.location', os.path.join(self.base_path, "config"))
+        self.bind("config.location", self.base_path / "config")
 
     def use_config_path(self, path: str = None):
-        self.bind('config.location', path)
+        self.bind("config.location", path)
 
         return self
 
     def use_storage_path(self, path: str = None):
-        self.bind('storage.location', path)
+        self.bind("storage.location", path)
 
         return self
 

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/src/fastapi_startkit/collection/collection.py

@@ -310,9 +310,7 @@ class Collection:
         if collection_count == 0:
             return None
         elif count and count > collection_count:
-            raise ValueError(
-                "count argument must be inferior to collection length."
-            )
+            raise ValueError("count argument must be inferior to collection length.")
         elif count:
             self._items = random.sample(self._items, k=count)
             return self
@@ -373,10 +371,7 @@ class Collection:
         return getattr(item, key, None)
 
     def sort(self, key=None, reverse=False):
-        self._items.sort(
-            key=lambda item: self.val(item, key),
-            reverse=reverse
-        )
+        self._items.sort(key=lambda item: self.val(item, key), reverse=reverse)
         return self
 
     def sum(self, key=None):
@@ -443,9 +438,7 @@ class Collection:
             if isinstance(item, dict):
                 comparison = item.get(key)
             else:
-                comparison = (
-                    getattr(item, key) if hasattr(item, key) else False
-                )
+                comparison = getattr(item, key) if hasattr(item, key) else False
             if self._make_comparison(comparison, value, op):
                 attributes.append(item)
         return self.__class__(attributes)
@@ -499,9 +492,7 @@ class Collection:
     def zip(self, items):
         items = self.__get_items(items)
         if not isinstance(items, list):
-            raise ValueError(
-                "The 'items' parameter must be a list or a Collection"
-            )
+            raise ValueError("The 'items' parameter must be a list or a Collection")
 
         _items = []
         for x, y in zip(self, items):

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/src/fastapi_startkit/commands/publish_command.py

@@ -15,13 +15,18 @@ class PublishCommand(Command):
     description = "Publish provider config files into the project."
 
     options = [
-        option("provider", "p", description="Provider name to publish (e.g. LogProvider, log_provider).", flag=False),
+        option(
+            "provider",
+            "p",
+            description="Provider name to publish (e.g. LogProvider, log_provider).",
+            flag=False,
+        ),
     ]
 
     def handle(self):
         from fastapi_startkit.application import app
 
-        application: 'Application' = app()
+        application: "Application" = app()
 
         if not application.published_resources:
             self.line("<comment>Nothing to publish.</comment>")
@@ -47,7 +52,10 @@ class PublishCommand(Command):
                 dest_path = application.use_base_path(destination)
 
                 if os.path.exists(dest_path):
-                    overwrite = self.confirm(f"  <comment>{destination}</comment> already exists. Overwrite?", default=False)
+                    overwrite = self.confirm(
+                        f"  <comment>{destination}</comment> already exists. Overwrite?",
+                        default=False,
+                    )
                     if not overwrite:
                         self.line(f"  [{provider_key}] Skipped <comment>{destination}</comment>")
                         continue

fastapi_startkit-0.14.0/src/fastapi_startkit/config/app.py

@@ -0,0 +1,13 @@
+import os
+from dataclasses import field, dataclass
+from fastapi_startkit.environment.environment import env
+
+
+@dataclass
+class AppConfig:
+    name: str = field(
+        default_factory=lambda: os.getenv("APP_NAME", "FastAPI starter kit")
+    )
+    env: str = field(default_factory=lambda: os.getenv("APP_ENV", "development"))
+    debug: bool = field(default_factory=lambda: env("APP_DEBUG", "true"))
+    timezone: str = field(default_factory=lambda: os.getenv("APP_TIMEZONE", "UTC"))

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/src/fastapi_startkit/configuration/Configuration.py

@@ -1,6 +1,6 @@
 from fastapi_startkit.loader import Loader
 from ..utils.structures import data
-from ..exceptions import InvalidConfigurationLocation, InvalidConfigurationSetup
+from ..exceptions import InvalidConfigurationSetup
 
 
 class Configuration:
@@ -26,14 +26,13 @@ class Configuration:
     def load(self):
         """At boot load configuration from all files and store them in here."""
         config_root = self.application.make("config.location")
-        for module_name, module in Loader().get_modules(
-            config_root, raise_exception=True
-        ).items():
+        for module_name, module in (
+            Loader().get_modules(config_root, raise_exception=True).items()
+        ):
             params = Loader().get_parameters(module)
             for name, value in params.items():
                 self._config[f"{module_name}.{name.lower()}"] = value
 
-
     def merge_with(self, path, external_config):
         """Merge external config at key with project config at same key. It's especially
         useful in Masonite packages in order to merge the configuration default package with
@@ -56,7 +55,9 @@ class Configuration:
         self.set(path, merged_config)
 
     def set(self, path, value):
-        self._config[path] = value
+        from fastapi_startkit.helpers.dataclass import Dataclass
+
+        self._config[path] = Dataclass.to_dict(value)
 
     def has(self, path):
         return path in self._config

fastapi_startkit-0.14.0/src/fastapi_startkit/configuration/config.py

@@ -0,0 +1,25 @@
+from typing import Any
+
+
+class Config:
+    @staticmethod
+    def instance():
+        from fastapi_startkit.application import app
+
+        return app().make("config")
+
+    @staticmethod
+    def get(path: str, default: Any = None) -> Any:
+        return Config.instance().get(path, default)
+
+    @staticmethod
+    def set(path: str, value: Any) -> None:
+        Config.instance().set(path, value)
+
+    @staticmethod
+    def has(path: str) -> bool:
+        return Config.instance().has(path)
+
+    @staticmethod
+    def all() -> dict:
+        return Config.instance().all()

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/src/fastapi_startkit/console.py

@@ -2,6 +2,7 @@ from cleo.application import Application as BaseApplication
 from cleo.io.io import IO
 from fastapi_startkit.application import Application
 
+
 class ConsoleApplication(BaseApplication):
     def __init__(self, app: Application):
         super().__init__()

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/src/fastapi_startkit/container/container.py

@@ -27,9 +27,8 @@ class Container:
             raise RuntimeError("Container not initialized")
         return cls._instance
 
-
     def __init__(self):
-        if not hasattr(self, 'objects'):
+        if not hasattr(self, "objects"):
             self.objects = {}
             self.strict = False
             self.override = True
@@ -216,7 +215,13 @@ class Container:
                 raise ContainerError(str(e))
         else:
             for _, value in self.get_parameters(obj):
-                if type(value.annotation) in (str, int, dict, list, tuple) or value.annotation in (str, int, dict, list, tuple):
+                if type(value.annotation) in (
+                    str,
+                    int,
+                    dict,
+                    list,
+                    tuple,
+                ) or value.annotation in (str, int, dict, list, tuple):
                     # Ignore any times a user is simply type hinting a parameter like (parameter:str or parameter:"str").
                     # In this case we don't want to resolve anything but we do want
                     # to insert any passing arguments we passed in
@@ -449,7 +454,6 @@ class Container:
             and obj in self._hooks[action]
             or obj.__class__ in self._hooks[action]
         ):
-
             for _, hook_list in self._hooks[action].items():
                 for hook_obj in hook_list:
                     hook_obj(obj, self)

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/src/fastapi_startkit/environment/environment.py

@@ -3,30 +3,51 @@
 import os
 import sys
 from dotenv import load_dotenv
-from pathlib import Path
 
 
-class LoadEnvironment:
-    def __init__(self, environment=None, override=True, only=None, base_path=None):
-        self.base_path = Path(base_path) if base_path else Path(".")
-        self._detect_env_from_argv()
+class Environment:
+    @staticmethod
+    def resolve_environment(base_path=None, env: str | None = None):
+        Environment.resolve_environment_from_argument()
 
-        if only:
-            self._load(f".env.{only}", override=override)
-            return
+        if "PYTEST_CURRENT_TEST" in os.environ:
+            return "testing"
+
+        # Explicit env parameter takes priority over os.environ APP_ENV
+        if env:
+            return env
+
+        if os.environ.get("APP_ENV"):
+            return os.environ["APP_ENV"]
+
+        path = base_path / ".env"
+        if not path.exists():
+            raise ValueError("Unable to determine environment.")
+
+        load_dotenv(path, override=True)
 
-        resolved = self._resolve_environment(environment)
+        env = os.environ.get("APP_ENV")
+        if not env:
+            raise ValueError("APP_ENV not set after loading .env")
 
-        # 2. Try .env.<resolved> first; fall back to .env when it doesn't exist.
-        if resolved:
-            specific = self.base_path / f".env.{resolved}"
-            if specific.exists():
-                load_dotenv(specific, override=override)
-                return
+        return env
 
-        load_dotenv(self.base_path / ".env", override=override)
+    @staticmethod
+    def load_base(base_path=None):
+        """Load the base .env file, resetting vars to their default values."""
+        path = base_path / ".env"
+        if path.exists():
+            load_dotenv(path, override=True)
+
+    @staticmethod
+    def load(env: str, override=True, only=None, base_path=None):
+        path = base_path / f".env.{env}"
+        if not path.exists():
+            return
+        load_dotenv(path, override=override)
 
-    def _detect_env_from_argv(self):
+    @staticmethod
+    def resolve_environment_from_argument():
         """Parse --env=<value> or --env <value> from sys.argv, set APP_ENV,
         and remove the tokens so downstream CLI parsers (e.g. cleo) never see them."""
         args = sys.argv[1:]
@@ -41,22 +62,6 @@ class LoadEnvironment:
                 sys.argv.pop(i + 1)  # then the flag
                 break
 
-    def _resolve_environment(self, fallback):
-        if "PYTEST_CURRENT_TEST" in os.environ:
-            return "testing"
-
-        if os.environ.get("APP_ENV"):
-            return os.environ["APP_ENV"]
-
-        if fallback:
-            return fallback
-
-        return None
-
-    def _load(self, filename, override=False):
-        path = self.base_path / filename
-        load_dotenv(path, override=override)
-
 
 def env(value, default="", cast=True):
     """Helper to retrieve the value of an environment variable or returns

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/src/fastapi_startkit/exceptions/handler.py

@@ -2,7 +2,6 @@ import sys
 import atexit
 from typing import Any, Callable, Dict, List, Optional, Type
 
-from dumpdie import dd
 
 
 class ExceptionHandler:
@@ -62,15 +61,24 @@ class ExceptionHandler:
         self.report_exception(exception)
 
     def report_exception(self, exception: Exception):
-        if self.app and self.app.has('logger'):
+        context = self._build_context(exception)
+        if self.app and self.app.has("logger"):
             from fastapi_startkit.logging.logger import Logger
-            Logger.error(self._build_context(exception))
+
+            Logger.error(context)
+        else:
+            print(context, file=sys.stderr)
 
     def _build_context(self, exception: Exception) -> str:
         import traceback
+
         context = f"{type(exception).__name__}: {exception}"
         if self.app and self.app.is_debug():
-            context += "\n" + "".join(traceback.format_exception(type(exception), exception, exception.__traceback__))
+            context += "\n" + "".join(
+                traceback.format_exception(
+                    type(exception), exception, exception.__traceback__
+                )
+            )
         return context
 
     async def handle(self, exception: Exception, context: Optional[Dict] = None) -> Any:

fastapi_startkit-0.14.0/src/fastapi_startkit/facades/Config.py

@@ -0,0 +1,3 @@
+from fastapi_startkit.configuration.config import Config
+
+__all__ = ["Config"]

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/src/fastapi_startkit/facades/Config.pyi

@@ -1,6 +1,5 @@
 from typing import Any
 
-
 class Config:
     """Configuration facades to manage Masonite config files."""
     @staticmethod

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/src/fastapi_startkit/facades/Facade.py

@@ -1,4 +1,5 @@
 class Facade(type):
     def __getattr__(self, attribute, *args, **kwargs):
         from ..application import app
+
         return getattr(app().make(self.key), attribute)

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/src/fastapi_startkit/facades/Vite.py

@@ -2,4 +2,4 @@ from .Facade import Facade
 
 
 class Vite(metaclass=Facade):
-    key = "vite"
+    key = "vite"

{fastapi_startkit-0.13.7 → fastapi_startkit-0.14.0}/src/fastapi_startkit/facades/Vite.pyi

@@ -1,6 +1,5 @@
 from typing import Callable, Optional
 
-
 class Vite:
     """Facade for the Vite asset helper.
 
@@ -89,4 +88,4 @@ class Vite:
     @staticmethod
     def to_html() -> str:
         """Render pre-configured entry points as an HTML string."""
-        ...
+        ...

fastapi_startkit-0.14.0/src/fastapi_startkit/fastapi/__init__.py

@@ -0,0 +1,4 @@
+from .providers.fastapi_provider import FastAPIProvider
+from .routers.router import Router
+
+__all__ = ["FastAPIProvider", "Router"]