microbootstrap 0.4.2__tar.gz → 0.4.4__tar.gz

{microbootstrap-0.4.2 → microbootstrap-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: microbootstrap
-Version: 0.4.2
+Version: 0.4.4
 Summary: Package for bootstrapping new micro-services
 Keywords: python,microservice,bootstrap,opentelemetry,logging,error-tracing,litestar,fastapi
 Author: community-of-python
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: Typing :: Typed
@@ -281,6 +282,7 @@ class YourFastApiSettings(FastApiSettings):
     service_name: str
 
     prometheus_metrics_path: str = "/metrics"
+    prometheus_metrics_include_in_schema: bool = False
     prometheus_instrumentator_params: dict[str, typing.Any] = {}
     prometheus_instrument_params: dict[str, typing.Any] = {}
     prometheus_expose_params: dict[str, typing.Any] = {}
@@ -292,6 +294,7 @@ 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_metrics_include_in_schema` - whether to include metrics route in OpenAPI schema.
 - `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(...)`.

{microbootstrap-0.4.2 → microbootstrap-0.4.4}/README.md

@@ -233,6 +233,7 @@ class YourFastApiSettings(FastApiSettings):
     service_name: str
 
     prometheus_metrics_path: str = "/metrics"
+    prometheus_metrics_include_in_schema: bool = False
     prometheus_instrumentator_params: dict[str, typing.Any] = {}
     prometheus_instrument_params: dict[str, typing.Any] = {}
     prometheus_expose_params: dict[str, typing.Any] = {}
@@ -244,6 +245,7 @@ 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_metrics_include_in_schema` - whether to include metrics route in OpenAPI schema.
 - `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(...)`.

{microbootstrap-0.4.2 → microbootstrap-0.4.4}/microbootstrap/bootstrappers/fastapi.py

@@ -106,6 +106,7 @@ class FastApiPrometheusInstrument(PrometheusInstrument[FastApiPrometheusConfig])
         ).expose(
             application,
             endpoint=self.instrument_config.prometheus_metrics_path,
+            include_in_schema=self.instrument_config.prometheus_metrics_include_in_schema,
             **self.instrument_config.prometheus_expose_params,
         )
         return application

{microbootstrap-0.4.2 → microbootstrap-0.4.4}/microbootstrap/bootstrappers/litestar.py

@@ -63,27 +63,25 @@ class LitestarSwaggerInstrument(SwaggerInstrument):
                 ),
             )
             if self.instrument_config.swagger_offline_docs
-            else ()
+            else (SwaggerRenderPlugin(),)
         )
 
-        openapi_config: typing.Final = openapi.OpenAPIConfig(
-            path=self.instrument_config.swagger_path,
-            title=self.instrument_config.service_name,
-            version=self.instrument_config.service_version,
-            description=self.instrument_config.service_description,
-            render_plugins=render_plugins,
-            **self.instrument_config.swagger_extra_params,
-        )
+        all_swagger_params: typing.Final = {
+            "path": self.instrument_config.swagger_path,
+            "title": self.instrument_config.service_name,
+            "version": self.instrument_config.service_version,
+            "description": self.instrument_config.service_description,
+            "render_plugins": render_plugins,
+        } | self.instrument_config.swagger_extra_params
 
-        bootstrap_result: typing.Final = {}
+        bootstrap_result: typing.Final[dict[str, typing.Any]] = {
+            "openapi_config": openapi.OpenAPIConfig(**all_swagger_params)
+        }
         if self.instrument_config.swagger_offline_docs:
             bootstrap_result["static_files_config"] = [
                 generate_static_files_config(static_files_handler_path=self.instrument_config.service_static_path),
             ]
-        return {
-            **bootstrap_result,
-            "openapi_config": openapi_config,
-        }
+        return bootstrap_result
 
 
 @LitestarBootstrapper.use_instrument()
@@ -126,6 +124,7 @@ class LitestarPrometheusInstrument(PrometheusInstrument[LitestarPrometheusConfig
     def bootstrap_before(self) -> dict[str, typing.Any]:
         class LitestarPrometheusController(PrometheusController):
             path = self.instrument_config.prometheus_metrics_path
+            include_in_schema = self.instrument_config.prometheus_metrics_include_in_schema
             openmetrics_format = True
 
         litestar_prometheus_config: typing.Final = PrometheusConfig(

{microbootstrap-0.4.2 → microbootstrap-0.4.4}/microbootstrap/instruments/prometheus_instrument.py

@@ -14,6 +14,7 @@ class BasePrometheusConfig(BaseInstrumentConfig):
     service_name: str = "micro-service"
 
     prometheus_metrics_path: str = "/metrics"
+    prometheus_metrics_include_in_schema: bool = False
 
 
 class LitestarPrometheusConfig(BasePrometheusConfig):

{microbootstrap-0.4.2 → microbootstrap-0.4.4}/pyproject.toml

@@ -26,7 +26,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
-version = "0.4.2"
+version = "0.4.4"
 description = "Package for bootstrapping new micro-services"
 authors = ["community-of-python"]
 readme = "README.md"