fastapi-factory-utilities 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

fastapi_factory_utilities-0.2.1.dist-info/RECORD

@@ -0,0 +1,71 @@
+fastapi_factory_utilities/__main__.py,sha256=w8o9KpyHcxGyLHmTK8ixbIqJIsB3NbIGuAMY7OfnxrA,147
+fastapi_factory_utilities/core/__init__.py,sha256=tt5a-MgeFt_oACkc9K5xl2rynIbca9DGqsKBDEqGzto,34
+fastapi_factory_utilities/core/api/__init__.py,sha256=eehUFVDPk07MUPIorGdC8WqDRB8NjdSy7Za55CdLrps,542
+fastapi_factory_utilities/core/api/tags.py,sha256=3hQcTeW0FS78sPTJ2PB44dMDTSkoW-xKj7rrfKX2Lk0,154
+fastapi_factory_utilities/core/api/v1/sys/__init__.py,sha256=mTXhpn3_KgQ1snt0-0PFmGvFr4n5srQRRADEdRSGFJM,345
+fastapi_factory_utilities/core/api/v1/sys/health.py,sha256=IF51Z1seOFn91m3FC57U8uWfAA7c_EhhBpjbu_ly9WQ,2807
+fastapi_factory_utilities/core/api/v1/sys/readiness.py,sha256=xIY8pQLShU7KWRtlOUK5gTDyZ8aB1KBvLczC6boT-tg,1711
+fastapi_factory_utilities/core/app/__init__.py,sha256=I04abOkkWiY9ChgkUNeiwnuWq8kkBoRAtMLBUKB7J7Y,405
+fastapi_factory_utilities/core/app/application.py,sha256=XdfQRG8IwyukEYXNF6i2s3qq0eAo1_XG9Xa9yV7zKf8,4975
+fastapi_factory_utilities/core/app/builder.py,sha256=aPmtnGPAsCF4vGIlqSLKWW5XW7JF3nBN7bfk_zudR28,4374
+fastapi_factory_utilities/core/app/config.py,sha256=7ELIoCy1AGCD4Zq7O-jZk6VJcqDU8H-00CSrvtwzdZE,6466
+fastapi_factory_utilities/core/app/enums.py,sha256=X1upnaehYU0eHExXTde5xsH-pI9q7HZDNsOEF5PApdg,226
+fastapi_factory_utilities/core/app/exceptions.py,sha256=tQDf0_4j5xgCbku7TL7JaZGs3_bjsWG2YLBCydQJpPw,664
+fastapi_factory_utilities/core/app/fastapi_builder.py,sha256=DgIqiCnJK6cqsG-sg4H7Pi0lkhaxOhSLQt_ksHjpjW0,2835
+fastapi_factory_utilities/core/app/plugin_manager/__init__.py,sha256=eMfxCsk41Caw_juAawmDZHhytNI_ubXmqfRDug2AzvQ,319
+fastapi_factory_utilities/core/app/plugin_manager/exceptions.py,sha256=CFrZvROT7mLzNpXWwDra1j08lA_7ZrSrOHN94sEEfnQ,1026
+fastapi_factory_utilities/core/app/plugin_manager/plugin_manager.py,sha256=5E_Qp535xNJHNujZ_QRiMfIkDUy9F_3Rbjlclny5P08,6682
+fastapi_factory_utilities/core/exceptions.py,sha256=7ntbaMptYn5OOPeKPVR4zU98NIC0j53NQSkqVP1bD68,1362
+fastapi_factory_utilities/core/plugins/__init__.py,sha256=W-BCkqP0xG980980z3mc8T6Vrp1Akv4szA0PRzkUbiU,756
+fastapi_factory_utilities/core/plugins/example/__init__.py,sha256=GF69IygLXxzrCh7VryekEWun663kKBhWtRS3w-1tzBc,1030
+fastapi_factory_utilities/core/plugins/httpx_plugin/__init__.py,sha256=P5FUyv7mQr8RZWQ8ifkoK8GXvqSI71q2b2dm-ag2JhQ,1028
+fastapi_factory_utilities/core/plugins/odm_plugin/__init__.py,sha256=zR1WCBdoXz6RCTJm_NbjSuLTS77hGXuRz0IOAE3kZ1I,5278
+fastapi_factory_utilities/core/plugins/odm_plugin/builder.py,sha256=xmDlyDyXzK2TU-FH4f0QlghBS9E0wvJyaboeI1PBTUE,7692
+fastapi_factory_utilities/core/plugins/odm_plugin/configs.py,sha256=_8sE7h9AkNLSeBdGgUIyaaZqt9HCnocioX324ZNg2wA,328
+fastapi_factory_utilities/core/plugins/odm_plugin/depends.py,sha256=OcLsfTLzMBk_xFV6qsMy_-qFkiphEbbEuaHUooagxg8,730
+fastapi_factory_utilities/core/plugins/odm_plugin/documents.py,sha256=ENEB-Lm3T7_tN1xuIYPsUh8fpWj4aqh0xmrZt6vJCK0,1075
+fastapi_factory_utilities/core/plugins/odm_plugin/exceptions.py,sha256=acnKJB0lGAzDs-7-LjBap8shjP3iV1a7dw7ouPVF27o,551
+fastapi_factory_utilities/core/plugins/odm_plugin/repositories.py,sha256=Wxh5C_gnU4jY8H5qpvcFuSlaM1dLrsDXqxGuuaxwB68,6912
+fastapi_factory_utilities/core/plugins/opentelemetry_plugin/__init__.py,sha256=UsXPjiAASn5GIHW8vrF32mklxGNq8ajILV-ty4K1Tbs,4371
+fastapi_factory_utilities/core/plugins/opentelemetry_plugin/builder.py,sha256=DsD1vUtTIMXCxLsQ2KbMaQthdPfvZsI95uLdD7pkeiE,9838
+fastapi_factory_utilities/core/plugins/opentelemetry_plugin/configs.py,sha256=4mMa5SrmnPY1R_gVFRtFhi9WNaTGEGZL5iNNhyjcZQ0,3448
+fastapi_factory_utilities/core/plugins/opentelemetry_plugin/exceptions.py,sha256=CpsHayfQpP0zghN8y5PP6TBy-cXhHoNxBR--I86gAdE,327
+fastapi_factory_utilities/core/plugins/opentelemetry_plugin/helpers.py,sha256=qpTIzX67orJz7vy6SBIwRs24omMBoToJkhpurZRjPuk,1533
+fastapi_factory_utilities/core/protocols.py,sha256=TzZKr_KfmTphk2LL-TD2XzxNlLbihbGM2DxWMhc5lEQ,2428
+fastapi_factory_utilities/core/services/status/__init__.py,sha256=N5H0cCN9ZFu_0YZar4RLdCDEjKMICrIhNtfKgB0LI78,370
+fastapi_factory_utilities/core/services/status/enums.py,sha256=IUxWAd0Ecknri4BqzaqoDRRhT_8LdcgtQcNqgNVDXGE,599
+fastapi_factory_utilities/core/services/status/exceptions.py,sha256=_fQFGqHKnG54Hs-ZtC4gs0xwzSH246_WwQOonraoGKw,856
+fastapi_factory_utilities/core/services/status/health_calculator_strategies.py,sha256=p2KKJo-dq1j9iWHT0mvlBKtldH9m8l31aytLkUsb9nQ,1634
+fastapi_factory_utilities/core/services/status/readiness_calculator_strategies.py,sha256=hA1LX2pSxva-7bVaQ0dw8NpTbl1ZWDtXd9xzqQUGUsI,1354
+fastapi_factory_utilities/core/services/status/services.py,sha256=qtgYdnxNQMbb6q6G9uGasRO3lZcpiWNmw1padPkh6jA,8490
+fastapi_factory_utilities/core/services/status/types.py,sha256=GJOGRra6NtpUS4q1cr4cdWR0BbIUtEwP7vQX-sXX5jQ,3297
+fastapi_factory_utilities/core/utils/configs.py,sha256=qM0pCrsK8ZyfCoyova_VrhR4eUX3LSPCbWunGMWcSVg,2581
+fastapi_factory_utilities/core/utils/importlib.py,sha256=DYcPo7K0s95WV5xxtucpufWsTj8Pxv25sWunDmmNUYI,797
+fastapi_factory_utilities/core/utils/log.py,sha256=6V9CL3bQio4e47YxcSXM2JQRGhVxuBfmcEbcF4RtCfQ,6393
+fastapi_factory_utilities/core/utils/status.py,sha256=1zxur98Wfum3JzpuzoAPoRIwQmXhFsTS2oxgbn5uFfg,1933
+fastapi_factory_utilities/core/utils/uvicorn.py,sha256=JJ_HNjpJz1IDQz3a4hPcxpf5_nhGypDUSdoZA7HkCvU,1335
+fastapi_factory_utilities/core/utils/yaml_reader.py,sha256=G7F1SFynghUYjuTZTNotNW9OIiCaeGAWkcYvTFYsCMQ,6101
+fastapi_factory_utilities/example/__init__.py,sha256=LEKnPTBcgDyfHeOjlVxjK5lFdFqS-7-mHDuVuM2Jh_Y,206
+fastapi_factory_utilities/example/__main__.py,sha256=Iwp_6rK7Lcv2F-XAKn6xjxQHOWjx2OjgwKAr91tfUfk,135
+fastapi_factory_utilities/example/api/__init__.py,sha256=qI82eeSwVjR6jSkX1pxm8ALv9WPQ_iHurFY4G2K7VzE,554
+fastapi_factory_utilities/example/api/books/__init__.py,sha256=zXARBnjywJwg1XsLbcixYWcHH4uC9mF-kbbX4P8cVgA,160
+fastapi_factory_utilities/example/api/books/responses.py,sha256=21WeD6bdg0MCD_0vRHwmsL4W79iDcG9NnDLemXysc84,540
+fastapi_factory_utilities/example/api/books/routes.py,sha256=bwg8Bhvoj9vx2SdwunzFS-Z3cHECtjl_yGdo8MfiGEM,1529
+fastapi_factory_utilities/example/app.py,sha256=mcXQOg0A74mc8xFT0XuRHne3YjXXI7dTMV48G_Ypng8,1555
+fastapi_factory_utilities/example/application.yaml,sha256=5xRyFSuMxmgZ5Mikai94UqKYJ7PxJp8omlXobTjv14M,485
+fastapi_factory_utilities/example/entities/books/__init__.py,sha256=q2UTwLyCs3te38n7RgwT0go3Hp0bE9-NvoX7P-DR-3o,185
+fastapi_factory_utilities/example/entities/books/entities.py,sha256=rLE01lE7U6WizrD5ZHMRwkynd8_dWF6DltBFH61f-Do,405
+fastapi_factory_utilities/example/entities/books/enums.py,sha256=lXYUvhIkT1pi0teflMpnqeafeiBZMokyWxoFLgzV6a8,330
+fastapi_factory_utilities/example/entities/books/types.py,sha256=7LYGPu-CcI3noIORJyIZlVF-CBugWPXEqgDzWrO3XmQ,1558
+fastapi_factory_utilities/example/models/__init__.py,sha256=RJmp3R9bhbQv7n0WOlsHP65LqbEs_DjF9hzYKwYTRGo,22
+fastapi_factory_utilities/example/models/books/__init__.py,sha256=1GJFCYMGZugQRxlFl-q7fPBFvNsl2ykeW8lV7rpURHU,181
+fastapi_factory_utilities/example/models/books/document.py,sha256=lYJfMGr5GqEEsn7L--PFs75hC2q-jQx77wl7EhTrp5U,568
+fastapi_factory_utilities/example/models/books/repository.py,sha256=7K63uAsSEGZ2EXqufU4Tc8KpymgXK8JX8WjAE2Sw8ok,387
+fastapi_factory_utilities/example/services/books/__init__.py,sha256=Z06yNRoA7Zg3TGN-Q9rrvJg6Bbx-qJw661MVwukV6vQ,148
+fastapi_factory_utilities/example/services/books/services.py,sha256=-x7d4hotUWLzWo5uImMjFmtNcSTHwWv2bfttIbYYKbA,5380
+fastapi_factory_utilities/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_factory_utilities-0.2.1.dist-info/LICENSE,sha256=iO1nLzMMst6vEiqgSUrfrbetM7b0bvdzXhbed5tqG8o,1074
+fastapi_factory_utilities-0.2.1.dist-info/METADATA,sha256=vmZIAlSo0KVgELzN0LWH9B3GnurywJGoCJ9_5WarIM0,3314
+fastapi_factory_utilities-0.2.1.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+fastapi_factory_utilities-0.2.1.dist-info/entry_points.txt,sha256=IK0VcBexXo4uXQmTrbfhhnnfq4GmXPRn0GBB8hzlsq4,101
+fastapi_factory_utilities-0.2.1.dist-info/RECORD,,

{fastapi_factory_utilities-0.1.0.dist-info → fastapi_factory_utilities-0.2.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.1
+Generator: poetry-core 2.1.1
 Root-Is-Purelib: true
 Tag: py3-none-any

fastapi_factory_utilities/core/app/base/__init__.py

@@ -1,17 +0,0 @@
-"""Package for the base application, abstract config classes and related exceptions."""
-
-from .application import BaseApplication
-from .config_abstract import AppConfigAbstract
-from .exceptions import (
-    ApplicationConfigFactoryException,
-    ApplicationFactoryException,
-    BaseApplicationException,
-)
-
-__all__: list[str] = [
-    "BaseApplication",
-    "AppConfigAbstract",
-    "ApplicationConfigFactoryException",
-    "ApplicationFactoryException",
-    "BaseApplicationException",
-]

fastapi_factory_utilities/core/app/base/application.py

@@ -1,123 +0,0 @@
-"""Provides the abstract class for the application."""
-
-from collections.abc import AsyncGenerator
-from contextlib import asynccontextmanager
-from typing import ClassVar, Self, cast
-
-import starlette.types
-from beanie import Document
-from fastapi import FastAPI
-
-from fastapi_factory_utilities.core.api import api
-from fastapi_factory_utilities.core.utils.log import LogModeEnum, setup_log
-
-from .config_abstract import AppConfigAbstract, AppConfigBuilder
-from .fastapi_application_abstract import FastAPIAbstract
-from .plugins_manager_abstract import (
-    ApplicationPluginManagerAbstract,
-    PluginsActivationList,
-)
-
-
-class BaseApplication(FastAPIAbstract, ApplicationPluginManagerAbstract):
-    """Application abstract class."""
-
-    PACKAGE_NAME: str = ""
-
-    CONFIG_CLASS: ClassVar[type[AppConfigAbstract]] = AppConfigAbstract
-
-    ODM_DOCUMENT_MODELS: ClassVar[list[type[Document]]] = []
-
-    def __init__(self, config: AppConfigAbstract, plugin_activation_list: PluginsActivationList | None = None) -> None:
-        """Instantiate the application.
-
-        Args:
-            config (AppConfigAbstract): The application configuration.
-            plugin_activation_list (PluginsActivationList | None, optional): The plugins activation list.
-
-        Returns:
-            None
-
-        Raises:
-            ValueError: If the package name is not set.
-        """
-        if self.PACKAGE_NAME == "":
-            raise ValueError("The package name must be set in the concrete application class.")
-
-        self._config: AppConfigAbstract = config
-        FastAPIAbstract.__init__(
-            self=cast(FastAPIAbstract, self),
-            config=self._config,
-            api_router=api,
-            lifespan=cast(starlette.types.StatelessLifespan[starlette.types.ASGIApp], self.fastapi_lifespan),
-        )
-        ApplicationPluginManagerAbstract.__init__(
-            self=cast(ApplicationPluginManagerAbstract, self), plugin_activation_list=plugin_activation_list
-        )
-        self._on_load()
-
-    @classmethod
-    def main(cls) -> None:
-        """Main function.
-
-        This must be the same for all applications.
-        """
-        from fastapi_factory_utilities.core.utils.uvicorn import (  # pylint: disable=import-outside-toplevel
-            UvicornUtils,
-        )
-
-        setup_log(mode=LogModeEnum.CONSOLE)
-        application: BaseApplication = cls.build()
-        uvicorn_utils = UvicornUtils(app=application)
-
-        try:
-            uvicorn_utils.serve()
-        except KeyboardInterrupt:
-            pass
-
-    @classmethod
-    def build_config(cls) -> AppConfigAbstract:
-        """Build the application configuration.
-
-        Returns:
-            AppConfigAbstract: The application configuration.
-        """
-        config_builder: AppConfigBuilder = AppConfigBuilder(
-            package_name=cls.PACKAGE_NAME, config_class=cls.CONFIG_CLASS
-        )
-        return config_builder.build()
-
-    @classmethod
-    def build(
-        cls, config: AppConfigAbstract | None = None, plugin_activation_list: PluginsActivationList | None = None
-    ) -> Self:
-        """Build the application.
-
-        Args:
-            config (AppConfigAbstract | None, optional): The application configuration. Defaults to None.
-            plugin_activation_list (PluginsActivationList | None, optional): The plugins activation list.
-            Defaults to None.
-        """
-        if config is None:
-            config = cls.build_config()
-
-        return cls(config=config, plugin_activation_list=plugin_activation_list)
-
-    @asynccontextmanager
-    async def fastapi_lifespan(self, fastapi_application: FastAPI) -> AsyncGenerator[None, None]:
-        """Provide the lifespan context manager for FastAPI.
-
-        Args:
-            fastapi_application (FastAPI): The FastAPI application.
-
-        Returns:
-            AsyncGenerator[None]: The lifespan context manager.
-        """
-        del fastapi_application
-        await self.plugins_on_startup()
-        yield
-        await self.plugins_on_shutdown()
-
-    def get_config(self) -> AppConfigAbstract:
-        """Get the application configuration."""
-        return self._config

fastapi_factory_utilities/core/app/base/config_abstract.py

@@ -1,78 +0,0 @@
-"""Provide the configuration for the app server."""
-
-from pydantic import Field
-
-from fastapi_factory_utilities.core.app.base.exceptions import (
-    ApplicationConfigFactoryException,
-)
-from fastapi_factory_utilities.core.app.base.plugins_manager_abstract import (
-    PluginsActivationList,
-)
-from fastapi_factory_utilities.core.utils.configs import (
-    UnableToReadConfigFileError,
-    ValueErrorConfigError,
-    build_config_from_file_in_package,
-)
-from fastapi_factory_utilities.core.utils.log import LoggingConfig
-
-from ..enums import EnvironmentEnum
-from .fastapi_application_abstract import FastAPIConfigAbstract
-
-
-class AppConfigAbstract(FastAPIConfigAbstract, PluginsActivationList):
-    """Application configuration abstract class."""
-
-    environment: EnvironmentEnum
-    service_name: str
-    service_namespace: str
-
-    logging: list[LoggingConfig] = Field(default_factory=list, description="Logging configuration.")
-
-
-class AppConfigBuilder:
-    """Application configuration builder."""
-
-    DEFAULT_FILENAME: str = "application.yaml"
-    DEFAULT_YAML_BASE_KEY: str = "application"
-
-    def __init__(
-        self,
-        package_name: str,
-        config_class: type[AppConfigAbstract],
-        filename: str = DEFAULT_FILENAME,
-        yaml_base_key: str = DEFAULT_YAML_BASE_KEY,
-    ) -> None:
-        """Instantiate the builder.
-
-        Args:
-            package_name (str): The package name.
-            config_class (Type[AppConfigAbstract]): The configuration class.
-            filename (str, optional): The filename. Defaults to DEFAULT_FILENAME.
-            yaml_base_key (str, optional): The YAML base key. Defaults to DEFAULT_YAML_BASE_KEY.
-        """
-        self.package_name: str = package_name
-        self.config_class: type[AppConfigAbstract] = config_class
-        self.filename: str = filename
-        self.yaml_base_key: str = yaml_base_key
-
-    def build(self) -> AppConfigAbstract:
-        """Build the configuration.
-
-        Returns:
-            AppConfigAbstract: The configuration.
-        """
-        try:
-            config: AppConfigAbstract = build_config_from_file_in_package(
-                package_name=self.package_name,
-                config_class=self.config_class,
-                filename=self.filename,
-                yaml_base_key=self.yaml_base_key,
-            )
-        except UnableToReadConfigFileError as exception:
-            raise ApplicationConfigFactoryException("Unable to read the application configuration file.") from exception
-        except ValueErrorConfigError as exception:
-            raise ApplicationConfigFactoryException(
-                "Unable to create the application configuration model."
-            ) from exception
-
-        return config

fastapi_factory_utilities/core/app/base/exceptions.py

@@ -1,25 +0,0 @@
-"""Provides the exceptions for the application factory."""
-
-
-class BaseApplicationException(BaseException):
-    """Base application exception."""
-
-    pass
-
-
-class ApplicationFactoryException(BaseApplicationException):
-    """Application factory exception."""
-
-    pass
-
-
-class ApplicationConfigFactoryException(BaseApplicationException):
-    """Application configuration factory exception."""
-
-    pass
-
-
-class ApplicationPluginManagerException(BaseApplicationException):
-    """Application plugin manager exception."""
-
-    pass

fastapi_factory_utilities/core/app/base/fastapi_application_abstract.py

@@ -1,88 +0,0 @@
-"""Provides an abstract class for FastAPI application integration."""
-
-from abc import ABC
-from typing import Any
-
-import starlette.types
-from fastapi import APIRouter, FastAPI
-from fastapi.middleware.cors import CORSMiddleware
-from pydantic import BaseModel, ConfigDict, Field
-
-
-class FastAPIConfigAbstract(ABC, BaseModel):
-    """Partial configuration for FastAPI."""
-
-    model_config = ConfigDict(strict=False)
-
-    # Application metadata
-    title: str
-    description: str
-    version: str
-
-    # Host configuration
-    host: str = Field(default="0.0.0.0")
-    port: int = Field(default=8000)
-
-    # Root configuration
-    root_path: str = Field(default="")
-
-    # Debug mode
-    debug: bool = Field(default=False, strict=False)
-
-    # Uvicorn configuration
-    reload: bool = Field(default=False, strict=False)
-    workers: int = Field(default=1, strict=False)
-
-
-class FastAPIAbstract(ABC):
-    """Application integration with FastAPI.
-
-    TODO: Replace by a Factory pattern.
-    """
-
-    def __init__(
-        self,
-        config: FastAPIConfigAbstract,
-        api_router: APIRouter | None = None,
-        lifespan: starlette.types.StatelessLifespan[starlette.types.ASGIApp] | None = None,
-    ) -> None:
-        """Instanciate the FastAPI application.
-
-        Args:
-            config (FastAPIConfigAbstract): The FastAPI configuration.
-            api_router (APIRouter, optional): The API router to include.
-                Defaults to None.
-            lifespan (AsyncGenerator[None, None], optional): The lifespan
-
-        Returns:
-            None
-
-        """
-        self._fastapi_app: FastAPI = FastAPI(
-            title=config.title,
-            description=config.description,
-            version=config.version,
-            root_path=config.root_path,
-            debug=config.debug,
-            lifespan=lifespan,
-        )
-
-        # TODO: Add CORS middleware Configuration
-        self._fastapi_app.add_middleware(
-            middleware_class=CORSMiddleware,
-            allow_origins=["*"],
-            allow_credentials=True,
-            allow_methods=["*"],
-            allow_headers=["*"],
-        )
-
-        if api_router is not None:
-            self._fastapi_app.include_router(router=api_router)
-
-    def get_asgi_app(self) -> FastAPI:
-        """Get the ASGI application."""
-        return self._fastapi_app
-
-    async def __call__(self, scope: Any, receive: Any, send: Any) -> None:
-        """Forward the call to the FastAPI app."""
-        return await self._fastapi_app.__call__(scope=scope, receive=receive, send=send)

fastapi_factory_utilities/core/app/base/plugins_manager_abstract.py

@@ -1,136 +0,0 @@
-"""Plugins manager abstract module."""
-
-from abc import ABC
-from importlib import import_module
-from types import ModuleType
-from typing import cast
-
-from pydantic import BaseModel, ConfigDict, Field
-
-from fastapi_factory_utilities.core.plugins import PluginsEnum
-from fastapi_factory_utilities.core.protocols import (
-    BaseApplicationProtocol,
-    PluginProtocol,
-)
-from fastapi_factory_utilities.core.utils.configs import (
-    UnableToReadConfigFileError,
-    ValueErrorConfigError,
-    build_config_from_file_in_package,
-)
-
-from .exceptions import ApplicationPluginManagerException
-
-
-class PluginsActivationList(BaseModel):
-    """Model for the plugins activation list."""
-
-    model_config = ConfigDict(extra="forbid")
-
-    activate: list[PluginsEnum] = Field(default=list())
-
-
-class ApplicationPluginManagerAbstract(ABC):
-    """Abstract class for the application plugin manager.
-
-    Responsibilities:
-    - Retrieve the plugins for the application.
-    - Check the pre-conditions for the plugins.
-    - Perform actions on startup for the plugins.
-    - Perform actions on shutdown for the plugins.
-    """
-
-    PACKAGE_NAME: str = ""
-
-    PLUGIN_PACKAGE_NAME: str = "fastapi_factory_utilities.core.plugins"
-
-    def __init__(self, plugin_activation_list: PluginsActivationList | None = None) -> None:
-        """Instanciate the application plugin manager."""
-        if self.PACKAGE_NAME == "":
-            raise ValueError("The package name must be set in the concrete plugin manager class.")
-
-        self._plugins: list[PluginProtocol] = []
-        self._plugins_activation_list: PluginsActivationList
-        if plugin_activation_list is not None:
-            self._plugins_activation_list = plugin_activation_list
-        else:
-            self._plugins_activation_list = self._build_plugins_activation_list()
-
-        self._check_pre_conditions()
-
-    def _check_pre_conditions(self) -> None:
-        """Check the pre-conditions for the plugins.
-
-        Raises:
-            ApplicationPluginManagerException: If a plugin is not
-            activated.
-
-        """
-        for plugin in self._plugins_activation_list.activate:
-            try:
-                plugin_module: ModuleType = import_module(name=f"{self.PLUGIN_PACKAGE_NAME}.{plugin.value}")
-            except ImportError as exception:
-                raise ApplicationPluginManagerException(f"Unable to import the plugin {plugin.value}") from exception
-
-            if not isinstance(plugin_module, PluginProtocol):
-                raise ApplicationPluginManagerException(
-                    f"The plugin {plugin.value} does not implement the PluginProtocol"
-                )
-
-            if not plugin_module.pre_conditions_check(application=cast(BaseApplicationProtocol, self)):
-                raise ApplicationPluginManagerException(f"The plugin {plugin.value} does not meet the pre-conditions")
-
-            self._plugins.append(plugin_module)
-
-    def _on_load(self) -> None:
-        """Actions to perform on load for the plugins."""
-        for plugin in self._plugins:
-            plugin.on_load(application=cast(BaseApplicationProtocol, self))
-
-    def _build_plugins_activation_list(self) -> PluginsActivationList:
-        """Build the plugins activation list.
-
-        Returns:
-            PluginsActivationList: The plugins activation list.
-
-        Raises:
-            ApplicationPluginManagerException: If there is an error
-            reading the configuration file.
-            ApplicationPluginManagerException: If there is an error
-            creating the configuration model.
-
-        """
-        try:
-            config: PluginsActivationList = build_config_from_file_in_package(
-                package_name=self.PACKAGE_NAME,
-                filename="application.yaml",
-                config_class=PluginsActivationList,
-                yaml_base_key="plugins",
-            )
-        except UnableToReadConfigFileError as exception:
-            raise ApplicationPluginManagerException("Unable to read the application configuration file") from exception
-        except ValueErrorConfigError as exception:
-            raise ApplicationPluginManagerException(
-                "Unable to create the application configuration model"
-            ) from exception
-
-        return config
-
-    async def plugins_on_startup(self) -> None:
-        """Actions to perform on startup for the plugins."""
-        for plugin in self._plugins:
-            try:
-                await plugin.on_startup(application=cast(BaseApplicationProtocol, self))
-            except Exception as exception:
-                raise ApplicationPluginManagerException(
-                    f"Error during the startup of the plugin {plugin.__class__.__name__}"
-                ) from exception
-
-    async def plugins_on_shutdown(self) -> None:
-        """Actions to perform on shutdown for the plugins."""
-        for plugin in self._plugins:
-            try:
-                await plugin.on_shutdown(application=cast(BaseApplicationProtocol, self))
-            except Exception as exception:
-                raise ApplicationPluginManagerException(
-                    f"Error during the shutdown of the plugin {plugin.__class__.__name__}"
-                ) from exception

fastapi_factory_utilities/example/app/__init__.py

@@ -1,6 +0,0 @@
-"""Provides the App and AppConfig classes."""
-
-from .app import App
-from .config import AppConfig
-
-__all__: list[str] = ["App", "AppConfig"]

fastapi_factory_utilities/example/app/app.py

@@ -1,37 +0,0 @@
-"""Provides the concrete application class."""
-
-from typing import ClassVar
-
-from beanie import Document
-
-from fastapi_factory_utilities.core.app import BaseApplication
-from fastapi_factory_utilities.core.app.base.plugins_manager_abstract import (
-    PluginsActivationList,
-)
-from fastapi_factory_utilities.example.models.books.document import BookDocument
-
-from .config import AppConfig
-
-
-class App(BaseApplication):
-    """Concrete application class."""
-
-    PACKAGE_NAME: str = "fastapi_factory_utilities.example"
-
-    CONFIG_CLASS = AppConfig
-
-    ODM_DOCUMENT_MODELS: ClassVar[list[type[Document]]] = [BookDocument]
-
-    def __init__(self, config: AppConfig, plugin_activation_list: PluginsActivationList | None = None) -> None:
-        """Instantiate the application with the configuration and the API router.
-
-        Args:
-            config (AppConfig): The application configuration.
-            plugin_activation_list (PluginsActivationList | None, optional): The plugins activation list.
-        """
-        super().__init__(config=config, plugin_activation_list=plugin_activation_list)
-
-        # Prevent circular imports
-        from ..api import api_router  # pylint: disable=import-outside-toplevel
-
-        self.get_asgi_app().include_router(router=api_router)

fastapi_factory_utilities/example/app/config.py

@@ -1,12 +0,0 @@
-"""Provides the application configuration."""
-
-from fastapi_factory_utilities.core.app import AppConfigAbstract
-
-
-class AppConfig(AppConfigAbstract):
-    """The application configuration.
-
-    Values are set in application.yaml.
-    """
-
-    pass