microbootstrap 0.0.4__tar.gz → 0.2.0__tar.gz

{microbootstrap-0.0.4 → microbootstrap-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: microbootstrap
-Version: 0.0.4
+Version: 0.2.0
 Summary: Package for bootstrapping new micro-services
 Keywords: python,microservice,bootstrap,opentelemetry,logging,error-tracing,litestar,fastapi
 Author: community-of-python
@@ -24,6 +24,7 @@ Requires-Dist: eval-type-backport (>=0.2.0,<0.3.0)
 Requires-Dist: fastapi (>=0.111.0,<0.112.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"
 Requires-Dist: opentelemetry-api (>=1.25.0,<2.0.0)
 Requires-Dist: opentelemetry-exporter-otlp (>=1.25.0,<2.0.0)
 Requires-Dist: opentelemetry-exporter-prometheus-remote-write (>=0.46b0,<0.47)
@@ -39,6 +40,9 @@ Requires-Dist: rich (>=13.7.1,<14.0.0)
 Requires-Dist: sentry-sdk (>=2.7.1,<3.0.0)
 Requires-Dist: structlog (>=24.2.0,<25.0.0)
 Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
+Project-URL: documentation, https://pypi.org/project/microbootstrap/
+Project-URL: homepage, https://github.com/community-of-python/microbootstrap
+Project-URL: repository, https://github.com/community-of-python/microbootstrap
 Description-Content-Type: text/markdown
 
 <p align="center">
@@ -46,15 +50,9 @@ Description-Content-Type: text/markdown
 </p>
 <br>
 <p align="center">
-    <a href="https://codecov.io/gh/community-of-python/microbootstrap" target="_blank">
-        <img src="https://codecov.io/gh/community-of-python/microbootstrap/branch/main/graph/badge.svg">
-    </a>
-    <a href="https://pypi.org/project/microbootstrap/" target="_blank">
-        <img src="https://img.shields.io/pypi/pyversions/microbootstrap">
-    </a>
-    <a href="https://pypi.org/project/microbootstrap/" target="_blank">
-        <img src="https://img.shields.io/pypi/v/microbootstrap">
-    </a>
+    <a href="https://codecov.io/gh/community-of-python/microbootstrap" target="_blank"><img src="https://codecov.io/gh/community-of-python/microbootstrap/branch/main/graph/badge.svg"></a>
+    <a href="https://pypi.org/project/microbootstrap/" target="_blank"><img src="https://img.shields.io/pypi/pyversions/microbootstrap"></a>
+    <a href="https://pypi.org/project/microbootstrap/" target="_blank"><img src="https://img.shields.io/pypi/v/microbootstrap"></a>
 </p>
 
 # microbootstrap
@@ -83,14 +81,15 @@ from your_application.settings import settings
 application: litestar.Litestar = LitestarBootstrapper(settings).bootstrap()
 ```
 
-With <b>microbootstrap</b>, you get an application with built-in support for:
+Only `litestar` is supported yet.  
+With <b>microbootstrap</b>, you get an application with lightweight built-in support for:
 
 - `sentry`
 - `prometheus`
 - `opentelemetry`
 - `logging`
-
-<b>microbootstrap</b> supports only `litestar` framework for now.
+- `cors`
+- `swagger` - additional offline version support
 
 Interested? Let's jump right into it ⚡
 
@@ -107,7 +106,7 @@ $ poetry add microbootstrap -E litestar
 pip:
 
 ```bash
-$ poetry add microbootstrap[litestar]
+$ pip install microbootstrap[litestar]
 ```
 
 ## Quickstart
@@ -212,6 +211,8 @@ Currently, these instruments are already supported for bootstrapping:
 - `prometheus`
 - `opentelemetry`
 - `logging`
+- `cors`
+- `swagger`
 
 Let's make it clear, what it takes to bootstrap them.
 
@@ -296,7 +297,7 @@ class YourSettings(BaseBootstrapSettings):
 
 All these settings are then passed to [opentelemetry](https://opentelemetry.io/), completing your Opentelemetry integration.
 
-## Logging
+### Logging
 
 <b>microbootstrap</b> provides in-memory json logging using [structlog](https://pypi.org/project/structlog/).  
 To learn more about in-memory logging, check out [MemoryHandler](https://docs.python.org/3/library/logging.handlers.html#memoryhandler)
@@ -329,6 +330,59 @@ Parameters description:
 - `logging_extra_processors` - set additional structlog processors if you have some.
 - `logging_exclude_endpoints` - remove logging on certain endpoints.
 
+### Swagger
+
+```python
+from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+
+
+class YourSettings(BaseBootstrapSettings):
+    service_name: str = "micro-service"
+    service_description: str = "Micro service description"
+    service_version: str = "1.0.0"
+    service_static_path: str = "/static"
+
+    swagger_path: str = "/docs"
+    swagger_offline_docs: bool = False
+    swagger_extra_params: dict[str, Any] = {}
+```
+
+Parameters description:
+
+- `service_environment` - will be displayed in docs.
+- `service_name` - will be displayed in docs.
+- `service_description` - will be displayed in docs.
+- `service_static_path` - set additional structlog processors if you have some.
+- `swagger_path` - path of the docs.
+- `swagger_offline_docs` - makes swagger js bundles access offline, because service starts to host via static.
+- `swagger_extra_params` - additional params to pass into openapi config.
+
+### Cors
+
+```python
+from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+
+
+class YourSettings(BaseBootstrapSettings):
+    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)
+    cors_exposed_headers: list[str] = pydantic.Field(default_factory=list)
+    cors_allowed_credentials: bool = False
+    cors_allowed_origin_regex: str | None = None
+    cors_max_age: int = 600
+```
+
+Parameters description:
+
+- `cors_allowed_origins` - list of origins that are allowed.
+- `cors_allowed_methods` - list of allowed HTTP methods.
+- `cors_allowed_headers` - list of allowed headers.
+- `cors_exposed_headers` - list of headers that are exposed via the 'Access-Control-Expose-Headers' header.
+- `cors_allowed_credentials` - boolean dictating whether or not to set the 'Access-Control-Allow-Credentials' header.
+- `cors_allowed_origin_regex` - regex to match origins against.
+- `cors_max_age` - response caching TTL in seconds, defaults to 600.
+
 ## Configuration
 
 Despite settings being pretty convenient mechanism, it's not always possible to store everything in settings.
@@ -343,6 +397,8 @@ To configure instruemt manually, you have to import one of available configs fro
 - `OpentelemetryConfig`
 - `PrometheusConfig`
 - `LoggingConfig`
+- `SwaggerConfig`
+- `CorsConfig`
 
 And pass them into `.configure_instrument` or `.configure_instruments` bootstrapper method.
 
@@ -453,7 +509,7 @@ application: litestar.Litestar = (
 > ```
 >
 > In this case prometheus will receive `{"first_value: 1", "second_value": 2}` inside `prometheus_additional_params`  
-> This is also true for `list`, `tuple` and `set`s
+> This is also true for `list`, `tuple` and `set`
 
 ## Advanced
 
@@ -477,8 +533,8 @@ from microbootstrap.instruments.base import Instrument
 
 
 class MyInstrument(Instrument[MyInstrumentConfig]):
-    def write_status(self, console_writer: ConsoleWriter) -> None:
-        pass
+    instrument_name: str
+    ready_condition: str
 
     def is_ready(self) -> bool:
         pass
@@ -496,10 +552,16 @@ class MyInstrument(Instrument[MyInstrumentConfig]):
 
 And now you can define behaviour of your instrument
 
-- `write_status` - writes status to console, indicating, is instrument bootstrapped.
-- `is_ready` - defines ready for bootstrapping state of instrument, based on it's config values.
-- `teardown` - graceful shutdown for instrument during application shutdown.
-- `bootstrap` - main instrument's logic.
+Attributes:
+
+- `instrument_name` - Will be displayed in your console during bootstrap.
+- `ready_condition` - Will be displayed in your console during bootstrap if instument is not ready.
+
+Methods:
+
+- `is_ready` - defines ready for bootstrapping state of instrument, based on it's config values. Required.
+- `teardown` - graceful shutdown for instrument during application shutdown. Not required.
+- `bootstrap` - main instrument's logic. Not required.
 
 When you have a carcass of instrument, you can adapt it for every framework existing.  
 Let's adapt it for litestar for example

{microbootstrap-0.0.4 → microbootstrap-0.2.0}/README.md

@@ -3,15 +3,9 @@
 </p>
 <br>
 <p align="center">
-    <a href="https://codecov.io/gh/community-of-python/microbootstrap" target="_blank">
-        <img src="https://codecov.io/gh/community-of-python/microbootstrap/branch/main/graph/badge.svg">
-    </a>
-    <a href="https://pypi.org/project/microbootstrap/" target="_blank">
-        <img src="https://img.shields.io/pypi/pyversions/microbootstrap">
-    </a>
-    <a href="https://pypi.org/project/microbootstrap/" target="_blank">
-        <img src="https://img.shields.io/pypi/v/microbootstrap">
-    </a>
+    <a href="https://codecov.io/gh/community-of-python/microbootstrap" target="_blank"><img src="https://codecov.io/gh/community-of-python/microbootstrap/branch/main/graph/badge.svg"></a>
+    <a href="https://pypi.org/project/microbootstrap/" target="_blank"><img src="https://img.shields.io/pypi/pyversions/microbootstrap"></a>
+    <a href="https://pypi.org/project/microbootstrap/" target="_blank"><img src="https://img.shields.io/pypi/v/microbootstrap"></a>
 </p>
 
 # microbootstrap
@@ -40,14 +34,15 @@ from your_application.settings import settings
 application: litestar.Litestar = LitestarBootstrapper(settings).bootstrap()
 ```
 
-With <b>microbootstrap</b>, you get an application with built-in support for:
+Only `litestar` is supported yet.  
+With <b>microbootstrap</b>, you get an application with lightweight built-in support for:
 
 - `sentry`
 - `prometheus`
 - `opentelemetry`
 - `logging`
-
-<b>microbootstrap</b> supports only `litestar` framework for now.
+- `cors`
+- `swagger` - additional offline version support
 
 Interested? Let's jump right into it ⚡
 
@@ -64,7 +59,7 @@ $ poetry add microbootstrap -E litestar
 pip:
 
 ```bash
-$ poetry add microbootstrap[litestar]
+$ pip install microbootstrap[litestar]
 ```
 
 ## Quickstart
@@ -169,6 +164,8 @@ Currently, these instruments are already supported for bootstrapping:
 - `prometheus`
 - `opentelemetry`
 - `logging`
+- `cors`
+- `swagger`
 
 Let's make it clear, what it takes to bootstrap them.
 
@@ -253,7 +250,7 @@ class YourSettings(BaseBootstrapSettings):
 
 All these settings are then passed to [opentelemetry](https://opentelemetry.io/), completing your Opentelemetry integration.
 
-## Logging
+### Logging
 
 <b>microbootstrap</b> provides in-memory json logging using [structlog](https://pypi.org/project/structlog/).  
 To learn more about in-memory logging, check out [MemoryHandler](https://docs.python.org/3/library/logging.handlers.html#memoryhandler)
@@ -286,6 +283,59 @@ Parameters description:
 - `logging_extra_processors` - set additional structlog processors if you have some.
 - `logging_exclude_endpoints` - remove logging on certain endpoints.
 
+### Swagger
+
+```python
+from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+
+
+class YourSettings(BaseBootstrapSettings):
+    service_name: str = "micro-service"
+    service_description: str = "Micro service description"
+    service_version: str = "1.0.0"
+    service_static_path: str = "/static"
+
+    swagger_path: str = "/docs"
+    swagger_offline_docs: bool = False
+    swagger_extra_params: dict[str, Any] = {}
+```
+
+Parameters description:
+
+- `service_environment` - will be displayed in docs.
+- `service_name` - will be displayed in docs.
+- `service_description` - will be displayed in docs.
+- `service_static_path` - set additional structlog processors if you have some.
+- `swagger_path` - path of the docs.
+- `swagger_offline_docs` - makes swagger js bundles access offline, because service starts to host via static.
+- `swagger_extra_params` - additional params to pass into openapi config.
+
+### Cors
+
+```python
+from microbootstrap.bootstrappers.litestar import BaseBootstrapSettings
+
+
+class YourSettings(BaseBootstrapSettings):
+    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)
+    cors_exposed_headers: list[str] = pydantic.Field(default_factory=list)
+    cors_allowed_credentials: bool = False
+    cors_allowed_origin_regex: str | None = None
+    cors_max_age: int = 600
+```
+
+Parameters description:
+
+- `cors_allowed_origins` - list of origins that are allowed.
+- `cors_allowed_methods` - list of allowed HTTP methods.
+- `cors_allowed_headers` - list of allowed headers.
+- `cors_exposed_headers` - list of headers that are exposed via the 'Access-Control-Expose-Headers' header.
+- `cors_allowed_credentials` - boolean dictating whether or not to set the 'Access-Control-Allow-Credentials' header.
+- `cors_allowed_origin_regex` - regex to match origins against.
+- `cors_max_age` - response caching TTL in seconds, defaults to 600.
+
 ## Configuration
 
 Despite settings being pretty convenient mechanism, it's not always possible to store everything in settings.
@@ -300,6 +350,8 @@ To configure instruemt manually, you have to import one of available configs fro
 - `OpentelemetryConfig`
 - `PrometheusConfig`
 - `LoggingConfig`
+- `SwaggerConfig`
+- `CorsConfig`
 
 And pass them into `.configure_instrument` or `.configure_instruments` bootstrapper method.
 
@@ -410,7 +462,7 @@ application: litestar.Litestar = (
 > ```
 >
 > In this case prometheus will receive `{"first_value: 1", "second_value": 2}` inside `prometheus_additional_params`  
-> This is also true for `list`, `tuple` and `set`s
+> This is also true for `list`, `tuple` and `set`
 
 ## Advanced
 
@@ -434,8 +486,8 @@ from microbootstrap.instruments.base import Instrument
 
 
 class MyInstrument(Instrument[MyInstrumentConfig]):
-    def write_status(self, console_writer: ConsoleWriter) -> None:
-        pass
+    instrument_name: str
+    ready_condition: str
 
     def is_ready(self) -> bool:
         pass
@@ -453,10 +505,16 @@ class MyInstrument(Instrument[MyInstrumentConfig]):
 
 And now you can define behaviour of your instrument
 
-- `write_status` - writes status to console, indicating, is instrument bootstrapped.
-- `is_ready` - defines ready for bootstrapping state of instrument, based on it's config values.
-- `teardown` - graceful shutdown for instrument during application shutdown.
-- `bootstrap` - main instrument's logic.
+Attributes:
+
+- `instrument_name` - Will be displayed in your console during bootstrap.
+- `ready_condition` - Will be displayed in your console during bootstrap if instument is not ready.
+
+Methods:
+
+- `is_ready` - defines ready for bootstrapping state of instrument, based on it's config values. Required.
+- `teardown` - graceful shutdown for instrument during application shutdown. Not required.
+- `bootstrap` - main instrument's logic. Not required.
 
 When you have a carcass of instrument, you can adapt it for every framework existing.  
 Let's adapt it for litestar for example

{microbootstrap-0.0.4 → microbootstrap-0.2.0}/microbootstrap/__init__.py

@@ -1,7 +1,9 @@
+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.sentry_instrument import SentryConfig
+from microbootstrap.instruments.swagger_instrument import SwaggerConfig
 from microbootstrap.settings import LitestarSettings
 
 
@@ -12,4 +14,6 @@ __all__ = (
     "LoggingConfig",
     "LitestarBootstrapper",
     "LitestarSettings",
+    "CorsConfig",
+    "SwaggerConfig",
 )

{microbootstrap-0.0.4 → microbootstrap-0.2.0}/microbootstrap/bootstrappers/litestar.py

@@ -5,18 +5,22 @@ import litestar
 import litestar.types
 import sentry_sdk
 import typing_extensions
-from litestar import status_codes
+from litestar import openapi, status_codes
 from litestar.config.app import AppConfig as LitestarConfig
+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_offline_docs import generate_static_files_config
 
 from microbootstrap.bootstrappers.base import ApplicationBootstrapper
+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.sentry_instrument import SentryInstrument
+from microbootstrap.instruments.swagger_instrument import SwaggerInstrument
 from microbootstrap.middlewares.litestar import build_litestar_logging_middleware
 from microbootstrap.settings import LitestarSettings
 
@@ -52,6 +56,53 @@ class LitestarSentryInstrument(SentryInstrument):
         return {"after_exception": [self.sentry_exception_catcher_hook]}
 
 
+@LitestarBootstrapper.use_instrument()
+class LitestarSwaggerInstrument(SwaggerInstrument):
+    def bootstrap_before(self) -> dict[str, typing.Any]:
+        class LitestarOpenAPIController(openapi.OpenAPIController):
+            path = self.instrument_config.swagger_path
+            if self.instrument_config.swagger_offline_docs:
+                swagger_ui_standalone_preset_js_url = (
+                    f"{self.instrument_config.service_static_path}/swagger-ui-standalone-preset.js"
+                )
+                swagger_bundle_path: str = f"{self.instrument_config.service_static_path}/swagger-ui-bundle.js"
+                swagger_css_url: str = f"{self.instrument_config.service_static_path}/swagger-ui.css"
+
+        openapi_config: typing.Final = openapi.OpenAPIConfig(
+            title=self.instrument_config.service_name,
+            version=self.instrument_config.service_version,
+            description=self.instrument_config.service_description,
+            openapi_controller=LitestarOpenAPIController,
+            **self.instrument_config.swagger_extra_params,
+        )
+
+        bootstrap_result = {}
+        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,
+        }
+
+
+@LitestarBootstrapper.use_instrument()
+class LitestarCorsInstrument(CorsInstrument):
+    def bootstrap_before(self) -> dict[str, typing.Any]:
+        return {
+            "cors_config": LitestarCorsConfig(
+                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,
+            ),
+        }
+
+
 @LitestarBootstrapper.use_instrument()
 class LitetstarOpentelemetryInstrument(OpentelemetryInstrument):
     def bootstrap_before(self) -> dict[str, typing.Any]:

{microbootstrap-0.0.4 → microbootstrap-0.2.0}/microbootstrap/instruments/base.py

@@ -23,6 +23,8 @@ class BaseInstrumentConfig(pydantic.BaseModel):
 @dataclasses.dataclass
 class Instrument(abc.ABC, typing.Generic[InstrumentConfigT]):
     instrument_config: InstrumentConfigT
+    instrument_name: typing.ClassVar[str]
+    ready_condition: typing.ClassVar[str]
 
     def configure_instrument(
         self,
@@ -30,27 +32,28 @@ class Instrument(abc.ABC, typing.Generic[InstrumentConfigT]):
     ) -> None:
         self.instrument_config = merge_pydantic_configs(self.instrument_config, incoming_config)
 
-    @abc.abstractmethod
     def write_status(self, console_writer: ConsoleWriter) -> None:
-        raise NotImplementedError
+        console_writer.write_instrument_status(
+            self.instrument_name,
+            is_enabled=self.is_ready(),
+            disable_reason=None if self.is_ready() else self.ready_condition,
+        )
 
     @abc.abstractmethod
     def is_ready(self) -> bool:
         raise NotImplementedError
 
-    @abc.abstractmethod
-    def bootstrap(self) -> None:
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def teardown(self) -> None:
-        raise NotImplementedError
-
     @classmethod
     @abc.abstractmethod
     def get_config_type(cls) -> type[InstrumentConfigT]:
         raise NotImplementedError
 
+    def bootstrap(self) -> None:
+        return None
+
+    def teardown(self) -> None:
+        return None
+
     def bootstrap_before(self) -> dict[str, typing.Any]:
         """Add some framework-related parameters to final bootstrap result before application creation."""
         return {}

microbootstrap-0.2.0/microbootstrap/instruments/cors_instrument.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+import pydantic
+
+from microbootstrap.instruments.base import BaseInstrumentConfig, Instrument
+
+
+class CorsConfig(BaseInstrumentConfig):
+    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)
+    cors_exposed_headers: list[str] = pydantic.Field(default_factory=list)
+    cors_allowed_credentials: bool = False
+    cors_allowed_origin_regex: str | None = None
+    cors_max_age: int = 600
+
+
+class CorsInstrument(Instrument[CorsConfig]):
+    instrument_name = "Cors"
+    ready_condition = "Provide allowed origins or regex"
+
+    def is_ready(self) -> bool:
+        return bool(self.instrument_config.cors_allowed_origins) or bool(
+            self.instrument_config.cors_allowed_origin_regex,
+        )
+
+    @classmethod
+    def get_config_type(cls) -> type[CorsConfig]:
+        return CorsConfig

{microbootstrap-0.0.4 → microbootstrap-0.2.0}/microbootstrap/instruments/logging_instrument.py

@@ -17,8 +17,6 @@ if typing.TYPE_CHECKING:
     import litestar
     from structlog.typing import EventDict, WrappedLogger
 
-    from microbootstrap.console_writer import ConsoleWriter
-
 
 ScopeType = typing.MutableMapping[str, typing.Any]
 
@@ -120,26 +118,19 @@ class MemoryLoggerFactory(structlog.stdlib.LoggerFactory):
 class LoggingConfig(BaseInstrumentConfig):
     service_debug: bool = True
 
-    logging_log_level: int = pydantic.Field(default=logging.INFO)
-    logging_flush_level: int = pydantic.Field(default=logging.ERROR)
-    logging_buffer_capacity: int = pydantic.Field(default=10)
+    logging_log_level: int = logging.INFO
+    logging_flush_level: int = logging.ERROR
+    logging_buffer_capacity: int = 10
     logging_extra_processors: list[typing.Any] = pydantic.Field(default_factory=list)
     logging_unset_handlers: list[str] = pydantic.Field(
         default_factory=lambda: ["uvicorn", "uvicorn.access"],
     )
-    logging_exclude_endpoints: list[str] = pydantic.Field(default_factory=lambda: ["/health"])
+    logging_exclude_endpoints: list[str] = pydantic.Field(default_factory=list)
 
 
 class LoggingInstrument(Instrument[LoggingConfig]):
-    def write_status(self, console_writer: ConsoleWriter) -> None:
-        if self.is_ready():
-            console_writer.write_instrument_status("Logging", is_enabled=True)
-        else:
-            console_writer.write_instrument_status(
-                "Logging",
-                is_enabled=False,
-                disable_reason="Works only in non-debug mode",
-            )
+    instrument_name = "Logging"
+    ready_condition = "Works only in non-debug mode"
 
     def is_ready(self) -> bool:
         return not self.instrument_config.service_debug

{microbootstrap-0.0.4 → microbootstrap-0.2.0}/microbootstrap/instruments/opentelemetry_instrument.py

@@ -12,10 +12,6 @@ from opentelemetry.sdk.trace.export import BatchSpanProcessor
 from microbootstrap.instruments.base import BaseInstrumentConfig, Instrument
 
 
-if typing.TYPE_CHECKING:
-    from microbootstrap.console_writer import ConsoleWriter
-
-
 @dataclasses.dataclass()
 class OpenTelemetryInstrumentor:
     instrumentor: BaseInstrumentor
@@ -23,8 +19,8 @@ class OpenTelemetryInstrumentor:
 
 
 class OpentelemetryConfig(BaseInstrumentConfig):
-    service_name: str = pydantic.Field(default="micro-service")
-    service_version: str = pydantic.Field(default="1.0.0")
+    service_name: str = "micro-service"
+    service_version: str = "1.0.0"
 
     opentelemetry_container_name: str | None = None
     opentelemetry_endpoint: str | None = None
@@ -35,15 +31,8 @@ class OpentelemetryConfig(BaseInstrumentConfig):
 
 
 class OpentelemetryInstrument(Instrument[OpentelemetryConfig]):
-    def write_status(self, console_writer: ConsoleWriter) -> None:
-        if self.is_ready():
-            console_writer.write_instrument_status("Opentelemetry", is_enabled=True)
-        else:
-            console_writer.write_instrument_status(
-                "Opentelemetry",
-                is_enabled=False,
-                disable_reason="Provide all necessary config parameters",
-            )
+    instrument_name = "Opentelemetry"
+    ready_condition = "Provide all necessary config parameters"
 
     def is_ready(self) -> bool:
         return all(

microbootstrap-0.2.0/microbootstrap/instruments/prometheus_instrument.py

@@ -0,0 +1,28 @@
+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

{microbootstrap-0.0.4 → microbootstrap-0.2.0}/microbootstrap/instruments/sentry_instrument.py

@@ -8,10 +8,6 @@ from sentry_sdk.integrations import Integration  # noqa: TCH002
 from microbootstrap.instruments.base import BaseInstrumentConfig, Instrument
 
 
-if typing.TYPE_CHECKING:
-    from microbootstrap.console_writer import ConsoleWriter
-
-
 class SentryConfig(BaseInstrumentConfig):
     service_environment: str | None = None
 
@@ -25,22 +21,12 @@ class SentryConfig(BaseInstrumentConfig):
 
 
 class SentryInstrument(Instrument[SentryConfig]):
-    def write_status(self, console_writer: ConsoleWriter) -> None:
-        if self.is_ready():
-            console_writer.write_instrument_status("Sentry", is_enabled=True)
-        else:
-            console_writer.write_instrument_status(
-                "Sentry",
-                is_enabled=False,
-                disable_reason="Provide sentry_dsn",
-            )
+    instrument_name = "Sentry"
+    ready_condition = "Provide sentry_dsn"
 
     def is_ready(self) -> bool:
         return bool(self.instrument_config.sentry_dsn)
 
-    def teardown(self) -> None:
-        return
-
     def bootstrap(self) -> None:
         sentry_sdk.init(
             dsn=self.instrument_config.sentry_dsn,

microbootstrap-0.2.0/microbootstrap/instruments/swagger_instrument.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+import typing
+
+import pydantic
+
+from microbootstrap.helpers import is_valid_path
+from microbootstrap.instruments.base import BaseInstrumentConfig, Instrument
+
+
+class SwaggerConfig(BaseInstrumentConfig):
+    service_name: str = "micro-service"
+    service_description: str = "Micro service description"
+    service_version: str = "1.0.0"
+    service_static_path: str = "/static"
+
+    swagger_path: str = "/docs"
+    swagger_offline_docs: bool = False
+    swagger_extra_params: dict[str, typing.Any] = pydantic.Field(default_factory=dict)
+
+
+class SwaggerInstrument(Instrument[SwaggerConfig]):
+    instrument_name = "Swagger"
+    ready_condition = "Provide valid swagger_path"
+
+    def is_ready(self) -> bool:
+        return bool(self.instrument_config.swagger_path) and is_valid_path(self.instrument_config.swagger_path)
+
+    @classmethod
+    def get_config_type(cls) -> type[SwaggerConfig]:
+        return SwaggerConfig

{microbootstrap-0.0.4 → microbootstrap-0.2.0}/microbootstrap/settings.py

@@ -2,10 +2,9 @@ from __future__ import annotations
 import os
 import typing
 
-import pydantic
 import pydantic_settings
 
-from microbootstrap.instruments import LoggingConfig, OpentelemetryConfig, PrometheusConfig, SentryConfig
+from microbootstrap import CorsConfig, LoggingConfig, OpentelemetryConfig, PrometheusConfig, SentryConfig, SwaggerConfig
 
 
 SettingsT = typing.TypeVar("SettingsT", bound="BaseBootstrapSettings")
@@ -19,12 +18,15 @@ class BaseBootstrapSettings(
     OpentelemetryConfig,
     SentryConfig,
     PrometheusConfig,
+    SwaggerConfig,
+    CorsConfig,
 ):
     service_debug: bool = True
     service_environment: str | None = None
-    service_name: str = pydantic.Field(default="micro-service")
-    service_description: str = pydantic.Field(default="Micro service description")
-    service_version: str = pydantic.Field(default="1.0.0")
+    service_name: str = "micro-service"
+    service_description: str = "Micro service description"
+    service_version: str = "1.0.0"
+    service_static_path: str = "/static"
 
     server_host: str = "0.0.0.0"  # noqa: S104
     server_port: int = 8000

{microbootstrap-0.0.4 → microbootstrap-0.2.0}/pyproject.toml

@@ -26,16 +26,25 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
-version = "0.0.4"
+version = "0.2.0"
 description = "Package for bootstrapping new micro-services"
 authors = ["community-of-python"]
 readme = "README.md"
 packages = [{ include = "microbootstrap" }]
 
+[tool.poetry.urls]
+homepage = "https://github.com/community-of-python/microbootstrap"
+repository = "https://github.com/community-of-python/microbootstrap"
+documentation = "https://pypi.org/project/microbootstrap/"
+
+
 [tool.poetry.dependencies]
 python = "^3.9"
 pydantic-settings = "^2.3.4"
 granian = { version = "^1.4.4", extras = ["reload"] }
+typing-extensions = "^4.12.2"
+rich = "^13.7.1"
+eval-type-backport = "^0.2.0"
 # for logging boostrap
 structlog = "^24.2.0"
 # for sentry bootstrap
@@ -49,15 +58,13 @@ opentelemetry-instrumentation = "^0.46b0"
 opentelemetry-instrumentation-asgi = "^0.46b0"
 opentelemetry-instrumentation-system-metrics = "^0.46b0"
 # optional extras for Litestar
-litestar = "^2.9.1"
+litestar = { version = "^2.9.1", optional = true }
 prometheus-client = { version = "^0.20.0", optional = true }
+litestar-offline-docs = { version = "^1.0.1", optional = true }
 # optional extras for FastAPI
-fastapi = "^0.111.0"
+fastapi = { version = "^0.111.0", optional = true }
 prometheus-fastapi-instrumentator = { version = "^6.1.0", optional = true }
 opentelemetry-instrumentation-fastapi = { version = "^0.46b0", optional = true }
-typing-extensions = "^4.12.2"
-rich = "^13.7.1"
-eval-type-backport = "^0.2.0"
 
 
 [tool.poetry.group.dev.dependencies]
@@ -78,7 +85,7 @@ fastapi = [
     "opentelemetry-instrumentation-fastapi",
     "prometheus-fastapi-instrumentator",
 ]
-litestar = ["litestar", "prometheus-client"]
+litestar = ["litestar", "prometheus-client", "litestar-offline-docs"]
 
 [build-system]
 requires = ["poetry-core"]

microbootstrap-0.0.4/microbootstrap/instruments/__init__.py

@@ -1,7 +0,0 @@
-from microbootstrap.instruments.logging_instrument import LoggingConfig
-from microbootstrap.instruments.opentelemetry_instrument import OpentelemetryConfig
-from microbootstrap.instruments.prometheus_instrument import PrometheusConfig
-from microbootstrap.instruments.sentry_instrument import SentryConfig
-
-
-__all__ = ("SentryConfig", "OpentelemetryConfig", "PrometheusConfig", "LoggingConfig")

microbootstrap-0.0.4/microbootstrap/instruments/prometheus_instrument.py

@@ -1,45 +0,0 @@
-from __future__ import annotations
-import typing
-
-import pydantic
-
-from microbootstrap.helpers import is_valid_path
-from microbootstrap.instruments.base import BaseInstrumentConfig, Instrument
-
-
-if typing.TYPE_CHECKING:
-    from microbootstrap.console_writer import ConsoleWriter
-
-
-class PrometheusConfig(BaseInstrumentConfig):
-    service_name: str = pydantic.Field(default="micro-service")
-
-    prometheus_metrics_path: str = pydantic.Field(default="/metrics")
-    prometheus_additional_params: dict[str, typing.Any] = pydantic.Field(default_factory=dict)
-
-
-class PrometheusInstrument(Instrument[PrometheusConfig]):
-    def write_status(self, console_writer: ConsoleWriter) -> None:
-        if self.is_ready():
-            console_writer.write_instrument_status("Prometheus", is_enabled=True)
-        else:
-            console_writer.write_instrument_status(
-                "Prometheus",
-                is_enabled=False,
-                disable_reason="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,
-        )
-
-    def teardown(self) -> None:
-        return
-
-    def bootstrap(self) -> None:
-        pass
-
-    @classmethod
-    def get_config_type(cls) -> type[PrometheusConfig]:
-        return PrometheusConfig