microbootstrap 0.2.3__tar.gz → 0.3.0__tar.gz

{microbootstrap-0.2.3 → microbootstrap-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: microbootstrap
-Version: 0.2.3
+Version: 0.3.0
 Summary: Package for bootstrapping new micro-services
 Keywords: python,microservice,bootstrap,opentelemetry,logging,error-tracing,litestar,fastapi
 Author: community-of-python
@@ -22,6 +22,7 @@ Provides-Extra: fastapi
 Provides-Extra: litestar
 Requires-Dist: eval-type-backport (>=0.2.0,<0.3.0)
 Requires-Dist: fastapi (>=0.111.0,<0.112.0) ; extra == "fastapi"
+Requires-Dist: fastapi-offline-docs (>=1.0.1,<2.0.0) ; extra == "fastapi"
 Requires-Dist: granian[reload] (>=1.4.4,<2.0.0)
 Requires-Dist: litestar (>=2.9.1,<3.0.0) ; extra == "litestar"
 Requires-Dist: litestar-offline-docs (>=1.0.1,<2.0.0) ; extra == "litestar"
@@ -80,7 +81,6 @@ from your_application.settings import settings
 application: litestar.Litestar = LitestarBootstrapper(settings).bootstrap()
 ```
 
-Currently, only `litestar` is supported.  
 With <b>microbootstrap</b>, you receive an application with lightweight built-in support for:
 
 - `sentry`
@@ -90,6 +90,11 @@ With <b>microbootstrap</b>, you receive an application with lightweight built-in
 - `cors`
 - `swagger` - with additional offline version support
 
+Those instruments can be bootstrapped for:
+
+- `fastapi`
+- `litestar`
+
 Interested? Let's dive right in ⚡
 
 ## Table of Contents
@@ -112,18 +117,22 @@ Interested? Let's dive right in ⚡
 
 ## Installation
 
-You can install the package using either `pip` or `poetry`.
+You can install the package using either `pip` or `poetry`.  
+Also, you can specify extras during installation for concrete framework:
+
+- `fastapi`
+- `litestar`
 
 For poetry:
 
 ```bash
-$ poetry add microbootstrap -E litestar
+$ poetry add microbootstrap -E fastapi
 ```
 
 For pip:
 
 ```bash
-$ pip install microbootstrap[litestar]
+$ pip install microbootstrap[fastapi]
 ```
 
 ## Quickstart
@@ -169,16 +178,16 @@ This approach will provide you with an application that has all the essential in
 
 The settings object is the core of microbootstrap.
 
-All framework-related settings inherit from the `BaseBootstrapSettings` object. `BaseBootstrapSettings` defines parameters for the service and various instruments.
+All framework-related settings inherit from the `BaseServiceSettings` object. `BaseServiceSettings` defines parameters for the service and various instruments.
 
-However, the number of parameters is <b>not confined</b> to those defined in `BaseBootstrapSettings`. You can add as many as you need.
+However, the number of parameters is <b>not confined</b> to those defined in `BaseServiceSettings`. You can add as many as you need.
 
 These parameters can be sourced from your environment. By default, no prefix is added to these parameters.
 
 Example:
 
 ```python
-class YourSettings(BaseBootstrapSettings):
+class YourSettings(BaseServiceSettings):
     service_debug: bool = True
     service_name: str = "micro-service"
 
@@ -206,10 +215,10 @@ Each settings object for every framework includes service parameters that can be
 You can configure them manually, or set the corresponding environment variables and let <b>microbootstrap</b> to source them automatically.
 
 ```python
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import BaseServiceSettings
 
 
-class ServiceSettings(BaseBootstrapSettings):
+class ServiceSettings(BaseServiceSettings):
     service_debug: bool = True
     service_environment: str | None = None
     service_name: str = "micro-service"
@@ -239,10 +248,10 @@ To bootstrap Sentry, you must provide at least the `sentry_dsn`.
 Additional parameters can also be supplied through the settings object.
 
 ```python
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import BaseServiceSettings
 
 
-class YourSettings(BaseBootstrapSettings):
+class YourSettings(BaseServiceSettings):
     service_environment: str | None = None
 
     sentry_dsn: str | None = None
@@ -260,14 +269,46 @@ These settings are subsequently passed to the [sentry-sdk](https://pypi.org/proj
 
 ### Prometheus
 
-To bootstrap Prometheus, you must provide at least the `prometheus_metrics_path`.  
-Additional parameters can also be supplied through the settings object.
+Prometheus is not an easy case, because two underlying libraries for `fastapi` and `litestar` are so different, that could not be cast to a single interface. For that reason prometheus settings for `fastapi` and `litestar` are a little bit different
+
+#### Fastapi
+
+To bootstrap prometheus you have to provide `prometheus_metrics_path`
+
+```python
+from microbootstrap.settings import FastApiSettings
+
+
+class YourFastApiSettings(FastApiSettings):
+    service_name: str
+
+    prometheus_metrics_path: str = "/metrics"
+    prometheus_instrumentator_params: dict[str, typing.Any] = {}
+    prometheus_instrument_params: dict[str, typing.Any] = {}
+    prometheus_expose_params: dict[str, typing.Any] = {}
+
+    ... # Other settings here
+```
+
+Parameters description:
+
+- `service_name` - will be attached to metric's names, but has to be named in [snake_case](https://en.wikipedia.org/wiki/Snake_case).
+- `prometheus_metrics_path` - path to metrics handler.
+- `prometheus_instrumentator_params` - will be passed to `Instrumentor` during initialization.
+- `prometheus_instrument_params` - will be passed to `Instrumentor.instrument(...)`.
+- `prometheus_expose_params` - will be passed to `Instrumentor.expose(...)`.
+
+FastApi prometheus bootstrapper uses [prometheus-fastapi-instrumentator](https://github.com/trallnag/prometheus-fastapi-instrumentator) that's why there are three different dict for parameters.
+
+#### Fastapi
+
+To bootstrap prometheus you have to provide `prometheus_metrics_path`
 
 ```python
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import LitestarSettings
 
 
-class YourSettings(BaseBootstrapSettings):
+class YourFastApiSettings(LitestarSettings):
     service_name: str
 
     prometheus_metrics_path: str = "/metrics"
@@ -276,10 +317,11 @@ class YourSettings(BaseBootstrapSettings):
     ... # Other settings here
 ```
 
-These settings are subsequently passed to the [prometheus-client](https://pypi.org/project/prometheus-client/) package.
-The underlying top-level Prometheus library may vary from framework to framework, but in general, a metrics handler will be available at the provided path.
+Parameters description:
 
-By default, metrics are accessible at the `/metrics` path.
+- `service_name` - will be attached to metric's names, there are no name restrictions.
+- `prometheus_metrics_path` - path to metrics handler.
+- `prometheus_additional_params` - will be passed to `litestar.contrib.prometheus.PrometheusConfig`.
 
 ### Opentelemetry
 
@@ -289,16 +331,16 @@ To bootstrap Opentelemetry, you must provide several parameters:
 - `service_version`
 - `opentelemetry_endpoint`
 - `opentelemetry_namespace`
-- `opentelemetry_container_name`.
+- `opentelemetry_container_name`
 
 However, additional parameters can also be supplied if needed.
 
 ```python
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import BaseServiceSettings
 from microbootstrap.instruments.opentelemetry_instrument import OpenTelemetryInstrumentor
 
 
-class YourSettings(BaseBootstrapSettings):
+class YourSettings(BaseServiceSettings):
     service_name: str
     service_version: str
 
@@ -306,12 +348,23 @@ class YourSettings(BaseBootstrapSettings):
     opentelemetry_endpoint: str | None = None
     opentelemetry_namespace: str | None = None
     opentelemetry_insecure: bool = True
-    opentelemetry_insrtumentors: list[OpenTelemetryInstrumentor] = []
+    opentelemetry_instrumentors: list[OpenTelemetryInstrumentor] = []
     opentelemetry_exclude_urls: list[str] = []
 
     ... # Other settings here
 ```
 
+Parameters description:
+
+- `service_name` - will be passed to the `Resource`.
+- `service_version` - will be passed to the `Resource`.
+- `opentelemetry_endpoint` - will be passed to `OTLPSpanExporter` as endpoint.
+- `opentelemetry_namespace` - will be passed to the `Resource`.
+- `opentelemetry_insecure` - is opentelemetry connection secure.
+- `opentelemetry_container_name` - will be passed to the `Resource`.
+- `opentelemetry_instrumentors` - a list of extra instrumentors.
+- `opentelemetry_exclude_urls` - list of ignored urls.
+
 These settings are subsequently passed to [opentelemetry](https://opentelemetry.io/), finalizing your Opentelemetry integration.
 
 ### Logging
@@ -324,10 +377,10 @@ To utilize this feature, your application must be in non-debug mode, meaning `se
 ```python
 import logging
 
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import BaseServiceSettings
 
 
-class YourSettings(BaseBootstrapSettings):
+class YourSettings(BaseServiceSettings):
     service_debug: bool = False
 
     logging_log_level: int = logging.INFO
@@ -338,7 +391,7 @@ class YourSettings(BaseBootstrapSettings):
     logging_exclude_endpoints: list[str] = []
 ```
 
-Parameter descriptions:
+Parameters description:
 
 - `logging_log_level` - The default log level.
 - `logging_flush_level` - All messages will be flushed from the buffer when a log with this level appears.
@@ -350,10 +403,10 @@ Parameter descriptions:
 ### CORS
 
 ```python
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import BaseServiceSettings
 
 
-class YourSettings(BaseBootstrapSettings):
+class YourSettings(BaseServiceSettings):
     cors_allowed_origins: list[str] = pydantic.Field(default_factory=list)
     cors_allowed_methods: list[str] = pydantic.Field(default_factory=list)
     cors_allowed_headers: list[str] = pydantic.Field(default_factory=list)
@@ -376,10 +429,10 @@ Parameter descriptions:
 ### Swagger
 
 ```python
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import BaseServiceSettings
 
 
-class YourSettings(BaseBootstrapSettings):
+class YourSettings(BaseServiceSettings):
     service_name: str = "micro-service"
     service_description: str = "Micro service description"
     service_version: str = "1.0.0"
@@ -459,8 +512,8 @@ The application can be configured in a similar manner:
 
 ```python
 import litestar
-from litestar.config.app import AppConfig
 
+from microbootstrap.config.litestar import LitestarConfig
 from microbootstrap.bootstrappers.litestar import LitestarBootstrapper
 from microbootstrap import SentryConfig, OpentelemetryConfig
 
@@ -471,7 +524,7 @@ async def my_handler() -> str:
 
 application: litestar.Litestar = (
     LitestarBootstrapper(settings)
-    .configure_application(AppConfig(route_handlers=[my_handler]))
+    .configure_application(LitestarConfig(route_handlers=[my_handler]))
     .bootstrap()
 )
 ```

{microbootstrap-0.2.3 → microbootstrap-0.3.0}/README.md

@@ -33,7 +33,6 @@ from your_application.settings import settings
 application: litestar.Litestar = LitestarBootstrapper(settings).bootstrap()
 ```
 
-Currently, only `litestar` is supported.  
 With <b>microbootstrap</b>, you receive an application with lightweight built-in support for:
 
 - `sentry`
@@ -43,6 +42,11 @@ With <b>microbootstrap</b>, you receive an application with lightweight built-in
 - `cors`
 - `swagger` - with additional offline version support
 
+Those instruments can be bootstrapped for:
+
+- `fastapi`
+- `litestar`
+
 Interested? Let's dive right in ⚡
 
 ## Table of Contents
@@ -65,18 +69,22 @@ Interested? Let's dive right in ⚡
 
 ## Installation
 
-You can install the package using either `pip` or `poetry`.
+You can install the package using either `pip` or `poetry`.  
+Also, you can specify extras during installation for concrete framework:
+
+- `fastapi`
+- `litestar`
 
 For poetry:
 
 ```bash
-$ poetry add microbootstrap -E litestar
+$ poetry add microbootstrap -E fastapi
 ```
 
 For pip:
 
 ```bash
-$ pip install microbootstrap[litestar]
+$ pip install microbootstrap[fastapi]
 ```
 
 ## Quickstart
@@ -122,16 +130,16 @@ This approach will provide you with an application that has all the essential in
 
 The settings object is the core of microbootstrap.
 
-All framework-related settings inherit from the `BaseBootstrapSettings` object. `BaseBootstrapSettings` defines parameters for the service and various instruments.
+All framework-related settings inherit from the `BaseServiceSettings` object. `BaseServiceSettings` defines parameters for the service and various instruments.
 
-However, the number of parameters is <b>not confined</b> to those defined in `BaseBootstrapSettings`. You can add as many as you need.
+However, the number of parameters is <b>not confined</b> to those defined in `BaseServiceSettings`. You can add as many as you need.
 
 These parameters can be sourced from your environment. By default, no prefix is added to these parameters.
 
 Example:
 
 ```python
-class YourSettings(BaseBootstrapSettings):
+class YourSettings(BaseServiceSettings):
     service_debug: bool = True
     service_name: str = "micro-service"
 
@@ -159,10 +167,10 @@ Each settings object for every framework includes service parameters that can be
 You can configure them manually, or set the corresponding environment variables and let <b>microbootstrap</b> to source them automatically.
 
 ```python
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import BaseServiceSettings
 
 
-class ServiceSettings(BaseBootstrapSettings):
+class ServiceSettings(BaseServiceSettings):
     service_debug: bool = True
     service_environment: str | None = None
     service_name: str = "micro-service"
@@ -192,10 +200,10 @@ To bootstrap Sentry, you must provide at least the `sentry_dsn`.
 Additional parameters can also be supplied through the settings object.
 
 ```python
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import BaseServiceSettings
 
 
-class YourSettings(BaseBootstrapSettings):
+class YourSettings(BaseServiceSettings):
     service_environment: str | None = None
 
     sentry_dsn: str | None = None
@@ -213,14 +221,46 @@ These settings are subsequently passed to the [sentry-sdk](https://pypi.org/proj
 
 ### Prometheus
 
-To bootstrap Prometheus, you must provide at least the `prometheus_metrics_path`.  
-Additional parameters can also be supplied through the settings object.
+Prometheus is not an easy case, because two underlying libraries for `fastapi` and `litestar` are so different, that could not be cast to a single interface. For that reason prometheus settings for `fastapi` and `litestar` are a little bit different
+
+#### Fastapi
+
+To bootstrap prometheus you have to provide `prometheus_metrics_path`
+
+```python
+from microbootstrap.settings import FastApiSettings
+
+
+class YourFastApiSettings(FastApiSettings):
+    service_name: str
+
+    prometheus_metrics_path: str = "/metrics"
+    prometheus_instrumentator_params: dict[str, typing.Any] = {}
+    prometheus_instrument_params: dict[str, typing.Any] = {}
+    prometheus_expose_params: dict[str, typing.Any] = {}
+
+    ... # Other settings here
+```
+
+Parameters description:
+
+- `service_name` - will be attached to metric's names, but has to be named in [snake_case](https://en.wikipedia.org/wiki/Snake_case).
+- `prometheus_metrics_path` - path to metrics handler.
+- `prometheus_instrumentator_params` - will be passed to `Instrumentor` during initialization.
+- `prometheus_instrument_params` - will be passed to `Instrumentor.instrument(...)`.
+- `prometheus_expose_params` - will be passed to `Instrumentor.expose(...)`.
+
+FastApi prometheus bootstrapper uses [prometheus-fastapi-instrumentator](https://github.com/trallnag/prometheus-fastapi-instrumentator) that's why there are three different dict for parameters.
+
+#### Fastapi
+
+To bootstrap prometheus you have to provide `prometheus_metrics_path`
 
 ```python
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import LitestarSettings
 
 
-class YourSettings(BaseBootstrapSettings):
+class YourFastApiSettings(LitestarSettings):
     service_name: str
 
     prometheus_metrics_path: str = "/metrics"
@@ -229,10 +269,11 @@ class YourSettings(BaseBootstrapSettings):
     ... # Other settings here
 ```
 
-These settings are subsequently passed to the [prometheus-client](https://pypi.org/project/prometheus-client/) package.
-The underlying top-level Prometheus library may vary from framework to framework, but in general, a metrics handler will be available at the provided path.
+Parameters description:
 
-By default, metrics are accessible at the `/metrics` path.
+- `service_name` - will be attached to metric's names, there are no name restrictions.
+- `prometheus_metrics_path` - path to metrics handler.
+- `prometheus_additional_params` - will be passed to `litestar.contrib.prometheus.PrometheusConfig`.
 
 ### Opentelemetry
 
@@ -242,16 +283,16 @@ To bootstrap Opentelemetry, you must provide several parameters:
 - `service_version`
 - `opentelemetry_endpoint`
 - `opentelemetry_namespace`
-- `opentelemetry_container_name`.
+- `opentelemetry_container_name`
 
 However, additional parameters can also be supplied if needed.
 
 ```python
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import BaseServiceSettings
 from microbootstrap.instruments.opentelemetry_instrument import OpenTelemetryInstrumentor
 
 
-class YourSettings(BaseBootstrapSettings):
+class YourSettings(BaseServiceSettings):
     service_name: str
     service_version: str
 
@@ -259,12 +300,23 @@ class YourSettings(BaseBootstrapSettings):
     opentelemetry_endpoint: str | None = None
     opentelemetry_namespace: str | None = None
     opentelemetry_insecure: bool = True
-    opentelemetry_insrtumentors: list[OpenTelemetryInstrumentor] = []
+    opentelemetry_instrumentors: list[OpenTelemetryInstrumentor] = []
     opentelemetry_exclude_urls: list[str] = []
 
     ... # Other settings here
 ```
 
+Parameters description:
+
+- `service_name` - will be passed to the `Resource`.
+- `service_version` - will be passed to the `Resource`.
+- `opentelemetry_endpoint` - will be passed to `OTLPSpanExporter` as endpoint.
+- `opentelemetry_namespace` - will be passed to the `Resource`.
+- `opentelemetry_insecure` - is opentelemetry connection secure.
+- `opentelemetry_container_name` - will be passed to the `Resource`.
+- `opentelemetry_instrumentors` - a list of extra instrumentors.
+- `opentelemetry_exclude_urls` - list of ignored urls.
+
 These settings are subsequently passed to [opentelemetry](https://opentelemetry.io/), finalizing your Opentelemetry integration.
 
 ### Logging
@@ -277,10 +329,10 @@ To utilize this feature, your application must be in non-debug mode, meaning `se
 ```python
 import logging
 
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import BaseServiceSettings
 
 
-class YourSettings(BaseBootstrapSettings):
+class YourSettings(BaseServiceSettings):
     service_debug: bool = False
 
     logging_log_level: int = logging.INFO
@@ -291,7 +343,7 @@ class YourSettings(BaseBootstrapSettings):
     logging_exclude_endpoints: list[str] = []
 ```
 
-Parameter descriptions:
+Parameters description:
 
 - `logging_log_level` - The default log level.
 - `logging_flush_level` - All messages will be flushed from the buffer when a log with this level appears.
@@ -303,10 +355,10 @@ Parameter descriptions:
 ### CORS
 
 ```python
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import BaseServiceSettings
 
 
-class YourSettings(BaseBootstrapSettings):
+class YourSettings(BaseServiceSettings):
     cors_allowed_origins: list[str] = pydantic.Field(default_factory=list)
     cors_allowed_methods: list[str] = pydantic.Field(default_factory=list)
     cors_allowed_headers: list[str] = pydantic.Field(default_factory=list)
@@ -329,10 +381,10 @@ Parameter descriptions:
 ### Swagger
 
 ```python
-from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+from microbootstrap.settings import BaseServiceSettings
 
 
-class YourSettings(BaseBootstrapSettings):
+class YourSettings(BaseServiceSettings):
     service_name: str = "micro-service"
     service_description: str = "Micro service description"
     service_version: str = "1.0.0"
@@ -412,8 +464,8 @@ The application can be configured in a similar manner:
 
 ```python
 import litestar
-from litestar.config.app import AppConfig
 
+from microbootstrap.config.litestar import LitestarConfig
 from microbootstrap.bootstrappers.litestar import LitestarBootstrapper
 from microbootstrap import SentryConfig, OpentelemetryConfig
 
@@ -424,7 +476,7 @@ async def my_handler() -> str:
 
 application: litestar.Litestar = (
     LitestarBootstrapper(settings)
-    .configure_application(AppConfig(route_handlers=[my_handler]))
+    .configure_application(LitestarConfig(route_handlers=[my_handler]))
     .bootstrap()
 )
 ```

{microbootstrap-0.2.3 → microbootstrap-0.3.0}/microbootstrap/__init__.py

@@ -1,19 +1,21 @@
 from microbootstrap.instruments.cors_instrument import CorsConfig
 from microbootstrap.instruments.logging_instrument import LoggingConfig
 from microbootstrap.instruments.opentelemetry_instrument import OpentelemetryConfig
-from microbootstrap.instruments.prometheus_instrument import PrometheusConfig
+from microbootstrap.instruments.prometheus_instrument import FastApiPrometheusConfig, LitestarPrometheusConfig
 from microbootstrap.instruments.sentry_instrument import SentryConfig
 from microbootstrap.instruments.swagger_instrument import SwaggerConfig
-from microbootstrap.settings import LitestarSettings
+from microbootstrap.settings import FastApiSettings, LitestarSettings
 
 
 __all__ = (
     "SentryConfig",
     "OpentelemetryConfig",
-    "PrometheusConfig",
+    "FastApiPrometheusConfig",
+    "LitestarPrometheusConfig",
     "LoggingConfig",
     "LitestarBootstrapper",
     "LitestarSettings",
+    "FastApiSettings",
     "CorsConfig",
     "SwaggerConfig",
 )

{microbootstrap-0.2.3 → microbootstrap-0.3.0}/microbootstrap/bootstrappers/base.py

@@ -24,15 +24,15 @@ class ApplicationBootstrapper(abc.ABC, typing.Generic[SettingsT, ApplicationT, D
     application_type: type[ApplicationT]
     application_config: DataclassT
     console_writer: ConsoleWriter
-    __instrument_box: InstrumentBox
+    instrument_box: InstrumentBox
 
     def __init__(self, settings: SettingsT) -> None:
         self.settings = settings
         self.console_writer = ConsoleWriter(writer_enabled=settings.service_debug)
 
-        if not hasattr(self, "__instrument_box"):
-            self.__instrument_box = InstrumentBox()
-        self.__instrument_box.initialize(self.settings)
+        if not hasattr(self, "instrument_box"):
+            self.instrument_box = InstrumentBox()
+        self.instrument_box.initialize(self.settings)
 
     def configure_application(
         self: typing_extensions.Self,
@@ -45,7 +45,7 @@ class ApplicationBootstrapper(abc.ABC, typing.Generic[SettingsT, ApplicationT, D
         self: typing_extensions.Self,
         instrument_config: InstrumentConfigT,
     ) -> typing_extensions.Self:
-        self.__instrument_box.configure_instrument(instrument_config)
+        self.instrument_box.configure_instrument(instrument_config)
         return self
 
     def configure_instruments(
@@ -63,27 +63,30 @@ class ApplicationBootstrapper(abc.ABC, typing.Generic[SettingsT, ApplicationT, D
         [type[Instrument[InstrumentConfigT]]],
         type[Instrument[InstrumentConfigT]],
     ]:
-        if not hasattr(cls, "__instrument_box"):
-            cls.__instrument_box = InstrumentBox()
-        return cls.__instrument_box.extend_instruments
+        if not hasattr(cls, "instrument_box"):
+            cls.instrument_box = InstrumentBox()
+        return cls.instrument_box.extend_instruments
 
     def bootstrap(self: typing_extensions.Self) -> ApplicationT:
-        resulting_application_config = dataclass_to_dict_no_defaults(self.application_config)
-        for instrument in self.__instrument_box.instruments:
+        resulting_application_config: dict[str, typing.Any] = {}
+        for instrument in self.instrument_box.instruments:
             if instrument.is_ready():
                 instrument.bootstrap()
-
                 resulting_application_config = merge_dict_configs(
                     resulting_application_config,
                     instrument.bootstrap_before(),
                 )
             instrument.write_status(self.console_writer)
 
+        resulting_application_config = merge_dict_configs(
+            resulting_application_config,
+            dataclass_to_dict_no_defaults(self.application_config),
+        )
         application = self.application_type(
             **merge_dict_configs(resulting_application_config, self.bootstrap_before()),
         )
 
-        for instrument in self.__instrument_box.instruments:
+        for instrument in self.instrument_box.instruments:
             if instrument.is_ready():
                 application = instrument.bootstrap_after(application)
 
@@ -98,5 +101,5 @@ class ApplicationBootstrapper(abc.ABC, typing.Generic[SettingsT, ApplicationT, D
         return application
 
     def teardown(self: typing_extensions.Self) -> None:
-        for instrument in self.__instrument_box.instruments:
+        for instrument in self.instrument_box.instruments:
             instrument.teardown()

microbootstrap-0.3.0/microbootstrap/bootstrappers/fastapi.py

@@ -0,0 +1,115 @@
+import typing
+
+import fastapi
+import typing_extensions
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi_offline_docs import enable_offline_docs
+from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
+from prometheus_fastapi_instrumentator import Instrumentator
+from sentry_sdk.integrations.fastapi import FastApiIntegration
+
+from microbootstrap.bootstrappers.base import ApplicationBootstrapper
+from microbootstrap.config.fastapi import FastApiConfig
+from microbootstrap.instruments.cors_instrument import CorsInstrument
+from microbootstrap.instruments.logging_instrument import LoggingInstrument
+from microbootstrap.instruments.opentelemetry_instrument import OpentelemetryInstrument
+from microbootstrap.instruments.prometheus_instrument import FastApiPrometheusConfig, PrometheusInstrument
+from microbootstrap.instruments.sentry_instrument import SentryInstrument
+from microbootstrap.instruments.swagger_instrument import SwaggerInstrument
+from microbootstrap.middlewares.fastapi import build_fastapi_logging_middleware
+from microbootstrap.settings import FastApiSettings
+
+
+class FastApiBootstrapper(
+    ApplicationBootstrapper[FastApiSettings, fastapi.FastAPI, FastApiConfig],
+):
+    application_config = FastApiConfig()
+    application_type = fastapi.FastAPI
+
+    def bootstrap_before(self: typing_extensions.Self) -> dict[str, typing.Any]:
+        return {
+            "debug": self.settings.service_debug,
+            "on_shutdown": [self.teardown],
+            "on_startup": [self.console_writer.print_bootstrap_table],
+        }
+
+
+@FastApiBootstrapper.use_instrument()
+class FastApiSentryInstrument(SentryInstrument):
+    def bootstrap(self) -> None:
+        for sentry_integration in self.instrument_config.sentry_integrations:
+            if isinstance(sentry_integration, FastApiIntegration):
+                break
+        else:
+            self.instrument_config.sentry_integrations.append(FastApiIntegration())
+        super().bootstrap()
+
+
+@FastApiBootstrapper.use_instrument()
+class FastApiSwaggerInstrument(SwaggerInstrument):
+    def bootstrap_before(self) -> dict[str, typing.Any]:
+        return {
+            "title": self.instrument_config.service_name,
+            "description": self.instrument_config.service_description,
+            "docs_url": self.instrument_config.swagger_path,
+            "version": self.instrument_config.service_version,
+        }
+
+    def bootstrap_after(self, application: fastapi.FastAPI) -> fastapi.FastAPI:
+        if self.instrument_config.swagger_offline_docs:
+            enable_offline_docs(application, static_files_handler=self.instrument_config.service_static_path)
+        return application
+
+
+@FastApiBootstrapper.use_instrument()
+class FastApiCorsInstrument(CorsInstrument):
+    def bootstrap_after(self, application: fastapi.FastAPI) -> fastapi.FastAPI:
+        application.add_middleware(
+            CORSMiddleware,
+            allow_origins=self.instrument_config.cors_allowed_origins,
+            allow_methods=self.instrument_config.cors_allowed_methods,
+            allow_headers=self.instrument_config.cors_allowed_headers,
+            allow_credentials=self.instrument_config.cors_allowed_credentials,
+            allow_origin_regex=self.instrument_config.cors_allowed_origin_regex,
+            expose_headers=self.instrument_config.cors_exposed_headers,
+            max_age=self.instrument_config.cors_max_age,
+        )
+        return application
+
+
+@FastApiBootstrapper.use_instrument()
+class FastApiOpentelemetryInstrument(OpentelemetryInstrument):
+    def bootstrap_after(self, application: fastapi.FastAPI) -> fastapi.FastAPI:
+        FastAPIInstrumentor.instrument_app(
+            application,
+            tracer_provider=self.tracer_provider,
+            excluded_urls=self.instrument_config.opentelemetry_exclude_urls,
+        )
+        return application
+
+
+@FastApiBootstrapper.use_instrument()
+class FastApiLoggingInstrument(LoggingInstrument):
+    def bootstrap_after(self, application: fastapi.FastAPI) -> fastapi.FastAPI:
+        application.add_middleware(
+            build_fastapi_logging_middleware(self.instrument_config.logging_exclude_endpoints),
+        )
+        return application
+
+
+@FastApiBootstrapper.use_instrument()
+class FastApiPrometheusInstrument(PrometheusInstrument[FastApiPrometheusConfig]):
+    def bootstrap_after(self, application: fastapi.FastAPI) -> fastapi.FastAPI:
+        Instrumentator(**self.instrument_config.prometheus_instrumentator_params).instrument(
+            application,
+            **self.instrument_config.prometheus_instrument_params,
+        ).expose(
+            application,
+            endpoint=self.instrument_config.prometheus_metrics_path,
+            **self.instrument_config.prometheus_expose_params,
+        )
+        return application
+
+    @classmethod
+    def get_config_type(cls) -> type[FastApiPrometheusConfig]:
+        return FastApiPrometheusConfig

{microbootstrap-0.2.3 → microbootstrap-0.3.0}/microbootstrap/bootstrappers/litestar.py

@@ -3,22 +3,20 @@ import typing
 
 import litestar
 import litestar.types
-import sentry_sdk
 import typing_extensions
-from litestar import openapi, status_codes
-from litestar.config.app import AppConfig as LitestarConfig
+from litestar import openapi
 from litestar.config.cors import CORSConfig as LitestarCorsConfig
 from litestar.contrib.opentelemetry.config import OpenTelemetryConfig as LitestarOpentelemetryConfig
-from litestar.contrib.prometheus import PrometheusConfig as LitestarPrometheusConfig
-from litestar.contrib.prometheus import PrometheusController
-from litestar.exceptions.http_exceptions import HTTPException
+from litestar.contrib.prometheus import PrometheusConfig, PrometheusController
 from litestar_offline_docs import generate_static_files_config
+from sentry_sdk.integrations.litestar import LitestarIntegration
 
 from microbootstrap.bootstrappers.base import ApplicationBootstrapper
+from microbootstrap.config.litestar import LitestarConfig
 from microbootstrap.instruments.cors_instrument import CorsInstrument
 from microbootstrap.instruments.logging_instrument import LoggingInstrument
 from microbootstrap.instruments.opentelemetry_instrument import OpentelemetryInstrument
-from microbootstrap.instruments.prometheus_instrument import PrometheusInstrument
+from microbootstrap.instruments.prometheus_instrument import LitestarPrometheusConfig, PrometheusInstrument
 from microbootstrap.instruments.sentry_instrument import SentryInstrument
 from microbootstrap.instruments.swagger_instrument import SwaggerInstrument
 from microbootstrap.middlewares.litestar import build_litestar_logging_middleware
@@ -41,19 +39,13 @@ class LitestarBootstrapper(
 
 @LitestarBootstrapper.use_instrument()
 class LitestarSentryInstrument(SentryInstrument):
-    @staticmethod
-    async def sentry_exception_catcher_hook(
-        exception: Exception,
-        _request_scope: litestar.types.Scope,
-    ) -> None:
-        if (
-            not isinstance(exception, HTTPException)
-            or exception.status_code >= status_codes.HTTP_500_INTERNAL_SERVER_ERROR
-        ):
-            sentry_sdk.capture_exception(exception)
-
-    def bootstrap_before(self) -> dict[str, typing.Any]:
-        return {"after_exception": [self.sentry_exception_catcher_hook]}
+    def bootstrap(self) -> None:
+        for sentry_integration in self.instrument_config.sentry_integrations:
+            if isinstance(sentry_integration, LitestarIntegration):
+                break
+        else:
+            self.instrument_config.sentry_integrations.append(LitestarIntegration())
+        super().bootstrap()
 
 
 @LitestarBootstrapper.use_instrument()
@@ -123,15 +115,19 @@ class LitestarLoggingInstrument(LoggingInstrument):
 
 
 @LitestarBootstrapper.use_instrument()
-class LitestarPrometheusInstrument(PrometheusInstrument):
+class LitestarPrometheusInstrument(PrometheusInstrument[LitestarPrometheusConfig]):
     def bootstrap_before(self) -> dict[str, typing.Any]:
         class LitestarPrometheusController(PrometheusController):
             path = self.instrument_config.prometheus_metrics_path
             openmetrics_format = True
 
-        litestar_prometheus_config: typing.Final = LitestarPrometheusConfig(
+        litestar_prometheus_config: typing.Final = PrometheusConfig(
             app_name=self.instrument_config.service_name,
             **self.instrument_config.prometheus_additional_params,
         )
 
         return {"route_handlers": [LitestarPrometheusController], "middleware": [litestar_prometheus_config.middleware]}
+
+    @classmethod
+    def get_config_type(cls) -> type[LitestarPrometheusConfig]:
+        return LitestarPrometheusConfig

microbootstrap-0.3.0/microbootstrap/config/fastapi.py

@@ -0,0 +1,66 @@
+from __future__ import annotations
+import dataclasses
+import typing
+
+from fastapi.datastructures import Default
+from fastapi.utils import generate_unique_id
+from starlette.responses import JSONResponse
+
+
+if typing.TYPE_CHECKING:
+    from fastapi import FastAPI, Request, routing
+    from fastapi.middleware import Middleware
+    from fastapi.params import Depends
+    from starlette.responses import Response
+    from starlette.routing import BaseRoute
+    from starlette.types import Lifespan
+
+
+AppType = typing.TypeVar("AppType", bound="FastAPI")
+
+
+@dataclasses.dataclass
+class FastApiConfig:
+    debug: bool = False
+    routes: list[BaseRoute] | None = None
+    title: str = "FastAPI"
+    summary: str | None = None
+    description: str = ""
+    version: str = "0.1.0"
+    openapi_url: str | None = "/openapi.json"
+    openapi_tags: list[dict[str, typing.Any]] | None = None
+    servers: list[dict[str, str | typing.Any]] | None = None
+    dependencies: typing.Sequence[Depends] | None = None
+    default_response_class: type[Response] = dataclasses.field(default_factory=lambda: Default(JSONResponse))
+    redirect_slashes: bool = True
+    docs_url: str | None = "/docs"
+    redoc_url: str | None = "/redoc"
+    swagger_ui_oauth2_redirect_url: str | None = "/docs/oauth2-redirect"
+    swagger_ui_init_oauth: dict[str, typing.Any] | None = None
+    middleware: typing.Sequence[Middleware] | None = None
+    exception_handlers: (
+        dict[
+            int | type[Exception],
+            typing.Callable[[Request, typing.Any], typing.Coroutine[typing.Any, typing.Any, Response]],
+        ]
+        | None
+    ) = None
+    on_startup: typing.Sequence[typing.Callable[[], typing.Any]] | None = None
+    on_shutdown: typing.Sequence[typing.Callable[[], typing.Any]] | None = None
+    lifespan: Lifespan[AppType] | None = None
+    terms_of_service: str | None = None
+    contact: dict[str, str | typing.Any] | None = None
+    license_info: dict[str, str | typing.Any] | None = None
+    openapi_prefix: str = ""
+    root_path: str = ""
+    root_path_in_servers: bool = True
+    responses: dict[int | str, dict[str, typing.Any]] | None = None
+    callbacks: list[BaseRoute] | None = None
+    webhooks: routing.APIRouter | None = None
+    deprecated: bool | None = None
+    include_in_schema: bool = True
+    swagger_ui_parameters: dict[str, typing.Any] | None = None
+    generate_unique_id_function: typing.Callable[[routing.APIRoute], str] = dataclasses.field(
+        default_factory=lambda: Default(generate_unique_id),
+    )
+    separate_input_output_schemas: bool = True

microbootstrap-0.3.0/microbootstrap/config/litestar.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+import dataclasses
+import typing
+
+from litestar.config.app import AppConfig
+
+
+if typing.TYPE_CHECKING:
+    from litestar.types import OnAppInitHandler
+
+
+@dataclasses.dataclass
+class LitestarConfig(AppConfig):
+    on_app_init: typing.Sequence[OnAppInitHandler] | None = None

{microbootstrap-0.2.3 → microbootstrap-0.3.0}/microbootstrap/granian_server.py

@@ -8,7 +8,7 @@ from granian.log import LogLevels
 
 
 if typing.TYPE_CHECKING:
-    from microbootstrap.settings import BaseBootstrapSettings
+    from microbootstrap.settings import BaseServiceSettings
 
 
 GRANIAN_LOG_LEVELS_MAP = {
@@ -24,7 +24,7 @@ GRANIAN_LOG_LEVELS_MAP = {
 # TODO: create bootstrappers for application servers. granian/uvicorn  # noqa: TD002
 def create_granian_server(
     target: str,
-    settings: BaseBootstrapSettings,
+    settings: BaseServiceSettings,
     **granian_options: typing.Any,  # noqa: ANN401
 ) -> granian.Granian:
     return granian.Granian(
@@ -34,7 +34,7 @@ def create_granian_server(
         interface=Interfaces.ASGI,
         loop=Loops.uvloop,
         workers=settings.server_workers_count,
-        log_level=GRANIAN_LOG_LEVELS_MAP[settings.logging_log_level],
+        log_level=GRANIAN_LOG_LEVELS_MAP[getattr(settings, "logging_log_level", logging.INFO)],
         reload=settings.server_reload,
         **granian_options,
     )

{microbootstrap-0.2.3 → microbootstrap-0.3.0}/microbootstrap/instruments/instrument_box.py

@@ -1,3 +1,4 @@
+import dataclasses
 import typing
 
 import typing_extensions
@@ -7,9 +8,10 @@ from microbootstrap.instruments.base import Instrument, InstrumentConfigT
 from microbootstrap.settings import SettingsT
 
 
+@dataclasses.dataclass
 class InstrumentBox:
-    __instruments__: typing.ClassVar[list[type[Instrument[typing.Any]]]] = []
-    __initialized_instruments__: list[Instrument[typing.Any]]
+    __instruments__: list[type[Instrument[typing.Any]]] = dataclasses.field(default_factory=list)
+    __initialized_instruments__: list[Instrument[typing.Any]] = dataclasses.field(default_factory=list)
 
     def initialize(self, settings: SettingsT) -> None:
         settings_dump = settings.model_dump()
@@ -31,19 +33,18 @@ class InstrumentBox:
             f"Instrument for config {instrument_config.__class__.__name__} is not supported yet.",
         )
 
-    @classmethod
     def extend_instruments(
-        cls,
+        self,
         instrument_class: type[Instrument[InstrumentConfigT]],
     ) -> type[Instrument[InstrumentConfigT]]:
         """Extend list of instruments, excluding one whose config is already in use."""
-        cls.__instruments__ = list(
+        self.__instruments__ = list(
             filter(
                 lambda instrument: instrument.get_config_type() is not instrument_class.get_config_type(),
-                cls.__instruments__,
+                self.__instruments__,
             ),
         )
-        cls.__instruments__.append(instrument_class)
+        self.__instruments__.append(instrument_class)
         return instrument_class
 
     @property

microbootstrap-0.3.0/microbootstrap/instruments/prometheus_instrument.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+import typing
+
+import pydantic
+
+from microbootstrap.helpers import is_valid_path
+from microbootstrap.instruments.base import BaseInstrumentConfig, Instrument
+
+
+PrometheusConfigT = typing.TypeVar("PrometheusConfigT", bound="BasePrometheusConfig")
+
+
+class BasePrometheusConfig(BaseInstrumentConfig):
+    service_name: str = "micro-service"
+
+    prometheus_metrics_path: str = "/metrics"
+
+
+class LitestarPrometheusConfig(BasePrometheusConfig):
+    prometheus_additional_params: dict[str, typing.Any] = pydantic.Field(default_factory=dict)
+
+
+class FastApiPrometheusConfig(BasePrometheusConfig):
+    prometheus_instrumentator_params: dict[str, typing.Any] = pydantic.Field(default_factory=dict)
+    prometheus_instrument_params: dict[str, typing.Any] = pydantic.Field(default_factory=dict)
+    prometheus_expose_params: dict[str, typing.Any] = pydantic.Field(default_factory=dict)
+
+
+class PrometheusInstrument(Instrument[PrometheusConfigT]):
+    instrument_name = "Prometheus"
+    ready_condition = "Provide metrics_path for metrics exposure"
+
+    def is_ready(self) -> bool:
+        return bool(self.instrument_config.prometheus_metrics_path) and is_valid_path(
+            self.instrument_config.prometheus_metrics_path,
+        )
+
+    @classmethod
+    def get_config_type(cls) -> type[BasePrometheusConfig]:
+        return BasePrometheusConfig

{microbootstrap-0.2.3 → microbootstrap-0.3.0}/microbootstrap/settings.py

@@ -4,22 +4,24 @@ import typing
 
 import pydantic_settings
 
-from microbootstrap import CorsConfig, LoggingConfig, OpentelemetryConfig, PrometheusConfig, SentryConfig, SwaggerConfig
+from microbootstrap import (
+    CorsConfig,
+    FastApiPrometheusConfig,
+    LitestarPrometheusConfig,
+    LoggingConfig,
+    OpentelemetryConfig,
+    SentryConfig,
+    SwaggerConfig,
+)
 
 
-SettingsT = typing.TypeVar("SettingsT", bound="BaseBootstrapSettings")
+SettingsT = typing.TypeVar("SettingsT", bound="BaseServiceSettings")
 ENVIRONMENT_PREFIX: typing.Final = "ENVIRONMENT_PREFIX"
 
 
 # TODO: add offline docs and cors support  # noqa: TD002
-class BaseBootstrapSettings(
+class BaseServiceSettings(
     pydantic_settings.BaseSettings,
-    LoggingConfig,
-    OpentelemetryConfig,
-    SentryConfig,
-    PrometheusConfig,
-    SwaggerConfig,
-    CorsConfig,
 ):
     service_debug: bool = True
     service_environment: str | None = None
@@ -41,5 +43,25 @@ class BaseBootstrapSettings(
     )
 
 
-class LitestarSettings(BaseBootstrapSettings):
+class LitestarSettings(
+    BaseServiceSettings,
+    LoggingConfig,
+    OpentelemetryConfig,
+    SentryConfig,
+    LitestarPrometheusConfig,
+    SwaggerConfig,
+    CorsConfig,
+):
     """Settings for a litestar botstrap."""
+
+
+class FastApiSettings(
+    BaseServiceSettings,
+    LoggingConfig,
+    OpentelemetryConfig,
+    SentryConfig,
+    FastApiPrometheusConfig,
+    SwaggerConfig,
+    CorsConfig,
+):
+    """Settings for a fastapi botstrap."""

{microbootstrap-0.2.3 → microbootstrap-0.3.0}/pyproject.toml

@@ -26,7 +26,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
-version = "0.2.3"
+version = "0.3.0"
 description = "Package for bootstrapping new micro-services"
 authors = ["community-of-python"]
 readme = "README.md"
@@ -65,7 +65,7 @@ litestar-offline-docs = { version = "^1.0.1", optional = true }
 fastapi = { version = "^0.111.0", optional = true }
 prometheus-fastapi-instrumentator = { version = "^6.1.0", optional = true }
 opentelemetry-instrumentation-fastapi = { version = "^0.46b0", optional = true }
-
+fastapi-offline-docs = { version = "^1.0.1", optional = true }
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.2.2"
@@ -79,11 +79,13 @@ redis = "^5.0.7"
 opentelemetry-instrumentation-redis = "^0.46b0"
 trio = "^0.26.0"
 
+
 [tool.poetry.extras]
 fastapi = [
     "fastapi",
     "opentelemetry-instrumentation-fastapi",
     "prometheus-fastapi-instrumentator",
+    "fastapi-offline-docs",
 ]
 litestar = ["litestar", "prometheus-client", "litestar-offline-docs"]
 

microbootstrap-0.2.3/microbootstrap/instruments/prometheus_instrument.py

@@ -1,28 +0,0 @@
-from __future__ import annotations
-import typing
-
-import pydantic
-
-from microbootstrap.helpers import is_valid_path
-from microbootstrap.instruments.base import BaseInstrumentConfig, Instrument
-
-
-class PrometheusConfig(BaseInstrumentConfig):
-    service_name: str = "micro-service"
-
-    prometheus_metrics_path: str = "/metrics"
-    prometheus_additional_params: dict[str, typing.Any] = pydantic.Field(default_factory=dict)
-
-
-class PrometheusInstrument(Instrument[PrometheusConfig]):
-    instrument_name = "Prometheus"
-    ready_condition = "Provide metrics_path for metrics exposure"
-
-    def is_ready(self) -> bool:
-        return bool(self.instrument_config.prometheus_metrics_path) and is_valid_path(
-            self.instrument_config.prometheus_metrics_path,
-        )
-
-    @classmethod
-    def get_config_type(cls) -> type[PrometheusConfig]:
-        return PrometheusConfig