Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
`lite-bootstrap` wires production observability — OpenTelemetry, Prometheus, Sentry, and structlog — into FastAPI, Litestar, and FastStream services in a few lines, with no boilerplate.

With `lite-bootstrap`, you receive an application with lightweight built-in support for:

- `sentry`
- `prometheus`
- `opentelemetry`
Expand Down
11 changes: 6 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Welcome to the `lite-bootstrap` documentation!
`lite-bootstrap` assists you in creating applications with all the necessary instruments already set up.

With `lite-bootstrap`, you receive an application with lightweight built-in support for:

- `sentry`
- `prometheus`
- `opentelemetry`
Expand All @@ -16,9 +17,9 @@ With `lite-bootstrap`, you receive an application with lightweight built-in supp

Those instruments can be bootstrapped for:

- [LiteStar](integrations/litestar)
- [FastStream](integrations/faststream)
- [FastAPI](integrations/fastapi)
- [FastMCP](integrations/fastmcp)
- [services and scripts without frameworks](integrations/free)
- [LiteStar](integrations/litestar.md)
- [FastStream](integrations/faststream.md)
- [FastAPI](integrations/fastapi.md)
- [FastMCP](integrations/fastmcp.md)
- [services and scripts without frameworks](integrations/free.md)
---
8 changes: 4 additions & 4 deletions docs/integrations/fastapi.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Usage with `Fastapi`
# Usage with `FastAPI`

*Another example of usage with FastAPI - [fastapi-sqlalchemy-template](https://github.com/modern-python/fastapi-sqlalchemy-template)*

Expand All @@ -22,9 +22,9 @@
poetry add lite-bootstrap[fastapi-all]
```

Read more about available extras [here](../../../introduction/installation):
Read more about available extras [here](../introduction/installation.md).

## 2. Define bootstrapper config and build you application:
## 2. Define bootstrapper config and build your application:

```python
from lite_bootstrap import FastAPIConfig, FastAPIBootstrapper
Expand All @@ -45,4 +45,4 @@ bootstrapper = FastAPIBootstrapper(bootstrapper_config)
application = bootstrapper.bootstrap()
```

Read more about available configuration options [here](../../../introduction/configuration):
Read more about available configuration options [here](../introduction/configuration.md).
4 changes: 2 additions & 2 deletions docs/integrations/fastmcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
poetry add lite-bootstrap[fastmcp-all]
```

Read more about available extras [here](../../../introduction/installation):
Read more about available extras [here](../introduction/installation.md).

## 2. Define bootstrapper config and build your application:

Expand Down Expand Up @@ -54,4 +54,4 @@ Teardown is wired through FastMCP's provider lifecycle — `bootstrapper.teardow
runs automatically when the FastMCP server's ASGI lifespan shuts down (i.e. when
the application that serves `application.http_app()` shuts down).

Read more about available configuration options [here](../../../introduction/configuration):
Read more about available configuration options [here](../introduction/configuration.md).
6 changes: 3 additions & 3 deletions docs/integrations/faststream.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
poetry add lite-bootstrap[faststream-all]
```

Read more about available extras [here](../../../introduction/installation):
Read more about available extras [here](../introduction/installation.md).

## 2. Define bootstrapper config and build you application:
## 2. Define bootstrapper config and build your application:

```python
from lite_bootstrap import FastStreamConfig, FastStreamBootstrapper
Expand Down Expand Up @@ -50,4 +50,4 @@ bootstrapper = FastStreamBootstrapper(bootstrapper_config)
application = bootstrapper.bootstrap()
```

Read more about available configuration options [here](../../../introduction/configuration):
Read more about available configuration options [here](../introduction/configuration.md).
6 changes: 3 additions & 3 deletions docs/integrations/free.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
poetry add lite-bootstrap[free-all]
```

Read more about available extras [here](../../../introduction/installation):
Read more about available extras [here](../introduction/installation.md).

## 2. Define bootstrapper config and build you application:
## 2. Define bootstrapper config and build your application:

```python
from lite_bootstrap import FreeBootstrapperConfig, FreeBootstrapper
Expand All @@ -36,4 +36,4 @@ bootstrapper = FreeBootstrapper(bootstrapper_config)
bootstrapper.bootstrap()
```

Read more about available configuration options [here](../../../introduction/configuration):
Read more about available configuration options [here](../introduction/configuration.md).
6 changes: 3 additions & 3 deletions docs/integrations/litestar.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
poetry add lite-bootstrap[litestar-all]
```

Read more about available extras [here](../../../introduction/installation):
Read more about available extras [here](../introduction/installation.md).

## 2. Define bootstrapper config and build you application:
## 2. Define bootstrapper config and build your application:

```python
from lite_bootstrap import LitestarConfig, LitestarBootstrapper
Expand All @@ -45,7 +45,7 @@ bootstrapper = LitestarBootstrapper(bootstrapper_config)
application = bootstrapper.bootstrap()
```

Read more about available configuration options [here](../../../introduction/configuration):
Read more about available configuration options [here](../introduction/configuration.md).

## Logging

Expand Down
1 change: 1 addition & 0 deletions docs/introduction/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Prometheus's integration for Litestar requires `prometheus_client` package.

Additional parameters for Litestar integration:

- `prometheus_group_path` - defaults to `True` so the `path` metric label uses the route template (`/users/{id}`) instead of the raw URL, bounding metric cardinality. Set to `False` to record raw paths.
- `prometheus_additional_params` - passed to `litestar.plugins.prometheus.PrometheusConfig`.

### Prometheus FastStream
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can choose required framework and instruments using this table:
* not used - means that the instrument is not implemented in the integration.
* no extra - means that the instrument requires no additional dependencies.

## Install `lite-bootstrap` using your favorite tool with choosen extras
## Install `lite-bootstrap` using your favorite tool with chosen extras

For example, if you want to bootstrap litestar with structlog and opentelemetry instruments:

Expand Down