litestar-redline 0.2.0a1__tar.gz

litestar_redline-0.2.0a1/.gitignore

@@ -0,0 +1,21 @@
+__pycache__/
+*.py[cod]
+.venv/
+venv/
+dist/
+build/
+site/
+.redline/
+*.db
+*.sqlite3
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+node_modules/
+frontend/dist/
+.DS_Store
+frontend/screenshots/
+
+# agent worktrees
+.claude/

litestar_redline-0.2.0a1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mahmoud Ahmed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

litestar_redline-0.2.0a1/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.5
+Name: litestar-redline
+Version: 0.2.0a1
+Summary: A modern request profiler for Litestar and SQLAlchemy: span timelines, N+1 detection with fix diffs, one-click EXPLAIN, flamegraphs and a fast web UI.
+Project-URL: Homepage, https://github.com/Pythondeveloper6/redline
+Project-URL: Documentation, https://pythondeveloper6.github.io/redline/litestar/
+Project-URL: Source, https://github.com/Pythondeveloper6/redline
+Project-URL: Issues, https://github.com/Pythondeveloper6/redline/issues
+Project-URL: Changelog, https://github.com/Pythondeveloper6/redline/blob/main/CHANGELOG.md
+Author-email: Mahmoud Ahmed <pythondeveloper6@gmail.com>
+Maintainer-email: Mahmoud Ahmed <pythondeveloper6@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: asgi,explain,flamegraph,litestar,n+1,performance,profiler,sqlalchemy
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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.14
+Classifier: Topic :: Software Development :: Debuggers
+Classifier: Topic :: System :: Monitoring
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: litestar<3,>=2.12
+Requires-Dist: redline-core==0.2.0a1
+Requires-Dist: sqlalchemy[asyncio]<3,>=2.0
+Provides-Extra: profile
+Requires-Dist: redline-core[profile]==0.2.0a1; extra == 'profile'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <a href="https://pythondeveloper6.github.io/redline/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Pythondeveloper6/redline/main/docs/assets/logo-dark.svg">
+      <img alt="Redline" src="https://raw.githubusercontent.com/Pythondeveloper6/redline/main/docs/assets/logo-light.svg" height="56">
+    </picture>
+  </a>
+</p>
+
+# litestar-redline
+
+The Litestar + SQLAlchemy adapter for [Redline](https://github.com/Pythondeveloper6/redline#readme): a request profiler and
+backend analyzer. Every request becomes a trace with a span timeline, the SQL it ran, N+1
+and duplicate-query detection with **concrete fix diffs**, one-click `EXPLAIN`, optional
+flamegraphs, and a fast web UI served from your own app.
+
+```python
+from litestar import Litestar
+from sqlalchemy.ext.asyncio import create_async_engine
+from litestar_redline import RedlinePlugin
+
+engine = create_async_engine("sqlite+aiosqlite:///app.db")
+
+app = Litestar(
+    route_handlers=[...],
+    # access="local": localhost only (unset, Redline answers 404 outside debug mode)
+    plugins=[RedlinePlugin(engine=engine, settings={"access": "local"})],  # UI at http://localhost:8000/_redline/
+)
+```
+
+Traces are stored in their own SQLite file (`.redline/redline.db`), never in your database.
+
+## Install
+
+```bash
+pip install \
+  "litestar-redline @ git+https://github.com/Pythondeveloper6/redline#subdirectory=packages/litestar-redline" \
+  "redline-core @ git+https://github.com/Pythondeveloper6/redline#subdirectory=packages/redline-core"
+```
+
+Not on PyPI yet: install from GitHub, naming `redline-core` in the same command (the adapter
+pins it exactly). Docs: <https://pythondeveloper6.github.io/redline/>.
+
+Add the extra to the core requirement for flamegraphs:
+`"redline-core[profile] @ git+https://github.com/Pythondeveloper6/redline#subdirectory=packages/redline-core"`.
+
+Python 3.10+, Litestar 2.12+ (< 3), SQLAlchemy 2.x.
+
+## `RedlinePlugin`
+
+```python
+RedlinePlugin(
+    settings=None,    # dict | redline_core.Settings
+    engine=None,      # Engine | AsyncEngine | [engines] | {"alias": engine}
+    path=None,        # default: the mount_path setting, else "/_redline"; never recorded
+    guards=None,      # Litestar guards for the UI + API (see "Access control")
+    store=None,       # custom Store (default: SQLite file at storage_path)
+)
+```
+
+What it does when the app is built:
+
+- adds a pure ASGI middleware (capture, route template, status, bodies, SQL spans);
+- records exceptions through Litestar's `after_exception` hook (see below);
+- mounts the UI and JSON API under `path` as a Litestar `Router`;
+- instruments the engines, and **flushes and closes the store on shutdown**
+  (`on_shutdown`; your own lifespan hooks keep working).
+
+`settings` takes any [Redline setting](../redline-core/README.md) with case-insensitive keys:
+
+```python
+RedlinePlugin(engine=engine, settings={
+    "sample_rate": 0.1,                 # keep 10% of requests ...
+    "always_keep_slower_than_ms": 300,  # ... plus every slow one and every error
+    "slow_query_ms": 50,
+})
+```
+
+The plugin object is also the handle: `plugin.recorder`, `plugin.store`, `plugin.settings`,
+`plugin.add_engine(engine)` for an engine created later, `plugin.close()`.
+
+### Engines
+
+With Litestar's own SQLAlchemy plugin (`advanced-alchemy`) and no `engine=`, the plugin's
+engine(s) are found and instrumented automatically:
+
+```python
+from advanced_alchemy.extensions.litestar import SQLAlchemyAsyncConfig, SQLAlchemyPlugin
+
+db = SQLAlchemyAsyncConfig(connection_string="sqlite+aiosqlite:///app.db")
+app = Litestar([...], plugins=[SQLAlchemyPlugin(config=db), RedlinePlugin()])
+```
+
+Otherwise pass `engine=` yourself. The first engine of a list is the `"default"` db alias
+(used by EXPLAIN); others are named after their database file, or pass a dict:
+
+```python
+RedlinePlugin(engine=[async_engine, sync_engine])
+RedlinePlugin(engine={"main": main_engine, "analytics": analytics_engine})
+```
+
+## What is recorded
+
+- **Request / response**: method, path, route template (`/orders/{order_id}`), handler
+  dotted name (`shop.routes.get_order`, `shop.routes.ShopController.by_sku`), status,
+  headers, query string and body. Secrets are redacted by the core.
+- **Bodies are never consumed or buffered unboundedly.** The request body is copied as the
+  app reads it; response bodies, including streams, are kept only up to `max_body_bytes`.
+- **SQL** through `before/after_cursor_execute`: statement, bound params (redacted),
+  duration, rowcount, vendor, executemany, `db_alias`, and the project line that issued the
+  query, also through `AsyncSession`.
+- **Exceptions.** Litestar turns an exception into a response *inside* the middleware, so
+  the plugin registers an `after_exception` hook. A 5xx caused by an exception gets
+  `error` (type, message, traceback, locals); a 4xx `HTTPException` (404, 401, validation)
+  is a client error and is not an error trace.
+- Sync handlers (`sync_to_thread=True`) are attributed to the right request.
+- Your own spans: `with redline_core.span("pricing.compute"): ...`.
+- `X-Redline-Run: <id>;step=<n>` becomes tags (used by the load tester).
+
+Requests that match no route (404) and `405 Method Not Allowed` never reach a route-level
+middleware, so Litestar does not run Redline for them.
+
+### Profiling
+
+Flamegraphs are opt-in per request: `?_redline=profile` or the header
+`X-Redline-Profile: 1` (needs the `[profile]` extra).
+
+### Outbound HTTP (httpx)
+
+```python
+from litestar_redline import instrument_httpx
+
+instrument_httpx()   # every httpx.Client / AsyncClient call becomes an http_out span
+```
+
+## Fix suggestions
+
+For an N+1, `SQLAlchemyFixSuggester` maps the repeated query back to your models and
+produces a real unified diff (`selectinload(Parent.children)`, `joinedload(Child.parent)`),
+exactly as in the FastAPI adapter.
+
+## Access control
+
+The UI exposes your SQL, request bodies and EXPLAIN, so treat it like an admin tool.
+
+**Default.** With no `guards`, the `access` setting decides (default `local`, served only in debug mode until you set `access`): only loopback clients (127.0.0.0/8, `::1`; unix sockets only with `trust_unix_socket`) that
+address the server by a loopback name (`Host: localhost`, `127.0.0.1`, `[::1]`, any port;
+this blocks DNS rebinding) are served, and a warning is logged at startup. Refusals are
+JSON `{"error": {"code": "forbidden" | "unauthorized" | ..., "message"}}`. Use
+the `allowed_hosts` setting to allow another host name. Passing `guards=` implies
+`access="framework"`. A loopback peer sending `X-Forwarded-For` without being in
+`trusted_proxies` is refused; behind a reverse proxy use `access="token"` and
+`trusted_proxies`. See the
+[access control docs](https://pythondeveloper6.github.io/redline/access-control/).
+
+**Your own guard** (any Litestar guard; it *replaces* the loopback default):
+
+```python
+from litestar.exceptions import NotAuthorizedException
+
+def require_admin(connection, _handler):
+    if not connection.user or not connection.user.is_admin:
+        raise NotAuthorizedException()
+
+RedlinePlugin(engine=engine, guards=[require_admin])
+```
+
+`guards=[]` is the same as passing none.
+
+**CSRF.** The mutating endpoints (`DELETE` traces, `POST explain`) reject browser requests
+whose `Origin` does not match the request host, `Origin: null`, and
+`Sec-Fetch-Site: cross-site` or `same-site`. This is always on, whatever `guards` you pass.
+
+Redline's own responses carry `X-Frame-Options: DENY`.
+
+## EXPLAIN
+
+`POST /_redline/api/explain` runs `EXPLAIN` for a recorded SELECT on the engine it came
+from inside a transaction that is always rolled back (`READ ONLY` on PostgreSQL). `EXPLAIN
+ANALYZE` executes the query, so it is off unless `explain_analyze=True`.
+
+## Development
+
+```bash
+uv sync --all-packages
+cd packages/litestar-redline && uv run pytest
+```
+
+## License
+
+MIT

litestar_redline-0.2.0a1/README.md

@@ -0,0 +1,191 @@
+<p align="center">
+  <a href="https://pythondeveloper6.github.io/redline/">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Pythondeveloper6/redline/main/docs/assets/logo-dark.svg">
+      <img alt="Redline" src="https://raw.githubusercontent.com/Pythondeveloper6/redline/main/docs/assets/logo-light.svg" height="56">
+    </picture>
+  </a>
+</p>
+
+# litestar-redline
+
+The Litestar + SQLAlchemy adapter for [Redline](https://github.com/Pythondeveloper6/redline#readme): a request profiler and
+backend analyzer. Every request becomes a trace with a span timeline, the SQL it ran, N+1
+and duplicate-query detection with **concrete fix diffs**, one-click `EXPLAIN`, optional
+flamegraphs, and a fast web UI served from your own app.
+
+```python
+from litestar import Litestar
+from sqlalchemy.ext.asyncio import create_async_engine
+from litestar_redline import RedlinePlugin
+
+engine = create_async_engine("sqlite+aiosqlite:///app.db")
+
+app = Litestar(
+    route_handlers=[...],
+    # access="local": localhost only (unset, Redline answers 404 outside debug mode)
+    plugins=[RedlinePlugin(engine=engine, settings={"access": "local"})],  # UI at http://localhost:8000/_redline/
+)
+```
+
+Traces are stored in their own SQLite file (`.redline/redline.db`), never in your database.
+
+## Install
+
+```bash
+pip install \
+  "litestar-redline @ git+https://github.com/Pythondeveloper6/redline#subdirectory=packages/litestar-redline" \
+  "redline-core @ git+https://github.com/Pythondeveloper6/redline#subdirectory=packages/redline-core"
+```
+
+Not on PyPI yet: install from GitHub, naming `redline-core` in the same command (the adapter
+pins it exactly). Docs: <https://pythondeveloper6.github.io/redline/>.
+
+Add the extra to the core requirement for flamegraphs:
+`"redline-core[profile] @ git+https://github.com/Pythondeveloper6/redline#subdirectory=packages/redline-core"`.
+
+Python 3.10+, Litestar 2.12+ (< 3), SQLAlchemy 2.x.
+
+## `RedlinePlugin`
+
+```python
+RedlinePlugin(
+    settings=None,    # dict | redline_core.Settings
+    engine=None,      # Engine | AsyncEngine | [engines] | {"alias": engine}
+    path=None,        # default: the mount_path setting, else "/_redline"; never recorded
+    guards=None,      # Litestar guards for the UI + API (see "Access control")
+    store=None,       # custom Store (default: SQLite file at storage_path)
+)
+```
+
+What it does when the app is built:
+
+- adds a pure ASGI middleware (capture, route template, status, bodies, SQL spans);
+- records exceptions through Litestar's `after_exception` hook (see below);
+- mounts the UI and JSON API under `path` as a Litestar `Router`;
+- instruments the engines, and **flushes and closes the store on shutdown**
+  (`on_shutdown`; your own lifespan hooks keep working).
+
+`settings` takes any [Redline setting](../redline-core/README.md) with case-insensitive keys:
+
+```python
+RedlinePlugin(engine=engine, settings={
+    "sample_rate": 0.1,                 # keep 10% of requests ...
+    "always_keep_slower_than_ms": 300,  # ... plus every slow one and every error
+    "slow_query_ms": 50,
+})
+```
+
+The plugin object is also the handle: `plugin.recorder`, `plugin.store`, `plugin.settings`,
+`plugin.add_engine(engine)` for an engine created later, `plugin.close()`.
+
+### Engines
+
+With Litestar's own SQLAlchemy plugin (`advanced-alchemy`) and no `engine=`, the plugin's
+engine(s) are found and instrumented automatically:
+
+```python
+from advanced_alchemy.extensions.litestar import SQLAlchemyAsyncConfig, SQLAlchemyPlugin
+
+db = SQLAlchemyAsyncConfig(connection_string="sqlite+aiosqlite:///app.db")
+app = Litestar([...], plugins=[SQLAlchemyPlugin(config=db), RedlinePlugin()])
+```
+
+Otherwise pass `engine=` yourself. The first engine of a list is the `"default"` db alias
+(used by EXPLAIN); others are named after their database file, or pass a dict:
+
+```python
+RedlinePlugin(engine=[async_engine, sync_engine])
+RedlinePlugin(engine={"main": main_engine, "analytics": analytics_engine})
+```
+
+## What is recorded
+
+- **Request / response**: method, path, route template (`/orders/{order_id}`), handler
+  dotted name (`shop.routes.get_order`, `shop.routes.ShopController.by_sku`), status,
+  headers, query string and body. Secrets are redacted by the core.
+- **Bodies are never consumed or buffered unboundedly.** The request body is copied as the
+  app reads it; response bodies, including streams, are kept only up to `max_body_bytes`.
+- **SQL** through `before/after_cursor_execute`: statement, bound params (redacted),
+  duration, rowcount, vendor, executemany, `db_alias`, and the project line that issued the
+  query, also through `AsyncSession`.
+- **Exceptions.** Litestar turns an exception into a response *inside* the middleware, so
+  the plugin registers an `after_exception` hook. A 5xx caused by an exception gets
+  `error` (type, message, traceback, locals); a 4xx `HTTPException` (404, 401, validation)
+  is a client error and is not an error trace.
+- Sync handlers (`sync_to_thread=True`) are attributed to the right request.
+- Your own spans: `with redline_core.span("pricing.compute"): ...`.
+- `X-Redline-Run: <id>;step=<n>` becomes tags (used by the load tester).
+
+Requests that match no route (404) and `405 Method Not Allowed` never reach a route-level
+middleware, so Litestar does not run Redline for them.
+
+### Profiling
+
+Flamegraphs are opt-in per request: `?_redline=profile` or the header
+`X-Redline-Profile: 1` (needs the `[profile]` extra).
+
+### Outbound HTTP (httpx)
+
+```python
+from litestar_redline import instrument_httpx
+
+instrument_httpx()   # every httpx.Client / AsyncClient call becomes an http_out span
+```
+
+## Fix suggestions
+
+For an N+1, `SQLAlchemyFixSuggester` maps the repeated query back to your models and
+produces a real unified diff (`selectinload(Parent.children)`, `joinedload(Child.parent)`),
+exactly as in the FastAPI adapter.
+
+## Access control
+
+The UI exposes your SQL, request bodies and EXPLAIN, so treat it like an admin tool.
+
+**Default.** With no `guards`, the `access` setting decides (default `local`, served only in debug mode until you set `access`): only loopback clients (127.0.0.0/8, `::1`; unix sockets only with `trust_unix_socket`) that
+address the server by a loopback name (`Host: localhost`, `127.0.0.1`, `[::1]`, any port;
+this blocks DNS rebinding) are served, and a warning is logged at startup. Refusals are
+JSON `{"error": {"code": "forbidden" | "unauthorized" | ..., "message"}}`. Use
+the `allowed_hosts` setting to allow another host name. Passing `guards=` implies
+`access="framework"`. A loopback peer sending `X-Forwarded-For` without being in
+`trusted_proxies` is refused; behind a reverse proxy use `access="token"` and
+`trusted_proxies`. See the
+[access control docs](https://pythondeveloper6.github.io/redline/access-control/).
+
+**Your own guard** (any Litestar guard; it *replaces* the loopback default):
+
+```python
+from litestar.exceptions import NotAuthorizedException
+
+def require_admin(connection, _handler):
+    if not connection.user or not connection.user.is_admin:
+        raise NotAuthorizedException()
+
+RedlinePlugin(engine=engine, guards=[require_admin])
+```
+
+`guards=[]` is the same as passing none.
+
+**CSRF.** The mutating endpoints (`DELETE` traces, `POST explain`) reject browser requests
+whose `Origin` does not match the request host, `Origin: null`, and
+`Sec-Fetch-Site: cross-site` or `same-site`. This is always on, whatever `guards` you pass.
+
+Redline's own responses carry `X-Frame-Options: DENY`.
+
+## EXPLAIN
+
+`POST /_redline/api/explain` runs `EXPLAIN` for a recorded SELECT on the engine it came
+from inside a transaction that is always rolled back (`READ ONLY` on PostgreSQL). `EXPLAIN
+ANALYZE` executes the query, so it is off unless `explain_analyze=True`.
+
+## Development
+
+```bash
+uv sync --all-packages
+cd packages/litestar-redline && uv run pytest
+```
+
+## License
+
+MIT

litestar_redline-0.2.0a1/pyproject.toml

@@ -0,0 +1,94 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "litestar-redline"
+version = "0.2.0a1"
+description = "A modern request profiler for Litestar and SQLAlchemy: span timelines, N+1 detection with fix diffs, one-click EXPLAIN, flamegraphs and a fast web UI."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Mahmoud Ahmed", email = "pythondeveloper6@gmail.com" }]
+maintainers = [{ name = "Mahmoud Ahmed", email = "pythondeveloper6@gmail.com" }]
+keywords = [
+    "litestar",
+    "asgi",
+    "sqlalchemy",
+    "profiler",
+    "performance",
+    "n+1",
+    "explain",
+    "flamegraph",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Web Environment",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Debuggers",
+    "Topic :: System :: Monitoring",
+    "Typing :: Typed",
+]
+# Lockstep: the adapter pins the exact core release it was tested with.
+dependencies = [
+    "redline-core==0.2.0a1",
+    "litestar>=2.12,<3",
+    "sqlalchemy[asyncio]>=2.0,<3",
+]
+
+[project.optional-dependencies]
+profile = ["redline-core[profile]==0.2.0a1"]
+
+[project.urls]
+Homepage = "https://github.com/Pythondeveloper6/redline"
+Documentation = "https://pythondeveloper6.github.io/redline/litestar/"
+Source = "https://github.com/Pythondeveloper6/redline"
+Issues = "https://github.com/Pythondeveloper6/redline/issues"
+Changelog = "https://github.com/Pythondeveloper6/redline/blob/main/CHANGELOG.md"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3",
+    "pytest-asyncio>=0.24",
+    "ruff>=0.8",
+    "httpx>=0.27",
+    "aiosqlite>=0.20",
+    "greenlet>=3.0",
+    "pyinstrument>=5.0",
+    "advanced-alchemy>=0.20",
+]
+
+[tool.uv.sources]
+redline-core = { workspace = true }
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/litestar_redline"]
+exclude = ["**/__pycache__", "**/*.py[cod]", "**/.DS_Store"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/src/litestar_redline", "/tests", "/README.md", "/LICENSE"]
+exclude = ["**/__pycache__", "**/*.py[cod]", "**/.DS_Store"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "--strict-markers -q"
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+filterwarnings = [
+    "ignore:The base_url:UserWarning",
+    "ignore:.*deprecated inferred style",
+    "ignore::sqlalchemy.exc.SADeprecationWarning",
+]
+
+[tool.ruff]
+extend = "../../pyproject.toml"

litestar_redline-0.2.0a1/src/litestar_redline/__init__.py

@@ -0,0 +1,37 @@
+"""litestar-redline: the Litestar + SQLAlchemy adapter for Redline.
+
+::
+
+    from litestar import Litestar
+    from sqlalchemy.ext.asyncio import create_async_engine
+    from litestar_redline import RedlinePlugin
+
+    engine = create_async_engine("sqlite+aiosqlite:///app.db")
+    app = Litestar(route_handlers=[...], plugins=[RedlinePlugin(engine=engine)])
+    # UI at /_redline/
+"""
+
+from __future__ import annotations
+
+from ._httpx import instrument_httpx, uninstrument_httpx
+from ._middleware import RedlineMiddleware
+from ._security import RedlineHTTPError, csrf_guard, local_only, loopback_guard
+from ._sqlalchemy import instrument_engine
+from .plugin import RedlinePlugin
+from .suggest import SQLAlchemyFixSuggester
+
+__version__ = "0.2.0a1"
+
+__all__ = [
+    "RedlineHTTPError",
+    "RedlineMiddleware",
+    "RedlinePlugin",
+    "SQLAlchemyFixSuggester",
+    "__version__",
+    "csrf_guard",
+    "instrument_engine",
+    "instrument_httpx",
+    "local_only",
+    "loopback_guard",
+    "uninstrument_httpx",
+]

litestar_redline-0.2.0a1/src/litestar_redline/_httpx.py

@@ -0,0 +1,5 @@
+"""Compatibility shim: the implementation lives in :mod:`redline_core.contrib.httpx`."""
+
+from redline_core.contrib.httpx import instrument_httpx, uninstrument_httpx
+
+__all__ = ["instrument_httpx", "uninstrument_httpx"]