sharpit

An embedded, local-only developer console for FastAPI apps. One call mounts a web console at /sharpit and a JSON API at /sharpit/api inside your own app, so a running service becomes understandable in minutes: its configuration and where each value came from, every route, the dependency providers, loggers you can retune live, and a vulnerability scan of the installed packages.

sharpit is a Python/FastAPI port of BootUI by Julien Dubois (Apache-2.0), the Spring Boot developer console. It ports BootUI's design goals, JSON contract and test cases; the UI is new.

Status: alpha (0.3.0, FastAPI only). Django and Flask are not supported. See CHANGELOG.md.

Install

sharpit is not on PyPI yet. Install it from git:

pip install "sharpit @ git+https://github.com/ffroliva/sharpit.git"
# or
uv add "sharpit @ git+https://github.com/ffroliva/sharpit.git"

Python 3.12+. Runtime dependencies are only starlette>=0.44 and packaging>=23. Optional extras:

Quickstart

from fastapi import FastAPI
import sharpit

app = FastAPI()

# Register your application's middleware first:
# app.add_middleware(...)

# Install sharpit after your app's middleware:
sharpit.install(app)  # mounts /sharpit and /sharpit/api

Call sharpit.install(app) after adding your own middleware. Starlette builds middleware from the outside in, so calling install() last ensures sharpit's capture middleware sits outside your application middleware. This lets sharpit measure total request durations and record unhandled errors correctly.

Run it with a dev signal and open http://127.0.0.1:8000/sharpit/:

fastapi dev app.py          # or: uvicorn app:app --reload

Keyword arguments for sharpit.install():

• engines: optional sequence of SQLAlchemy Engine or AsyncEngine instances to monitor in connection pools and health checks (e.g. engines=[engine]). If omitted, engines are discovered automatically on first connection.
• health_checks: optional mapping of check names to zero-argument callables (e.g. health_checks={"cache": ping_cache}).
• alembic_config: optional path to alembic.ini (default "alembic.ini").
• settings: optional pydantic-settings instance or sequence of instances to show configuration provenance.

Other options are keyword arguments or environment variables, see Settings.

If /sharpit answers 404, read Activation: sharpit stays off unless a dev signal turns it on.

Gate CI on findings

sharpit turns runtime capture into automated test gates with pytest --sharpit. It tracks SQL statements and observable exceptions per test, detects N+1 queries, checks query budgets, and runs static analysis advisors. If a test exceeds its query budget, triggers an N+1 query, or swallows an unhandled exception, the build fails. When capture cannot see enough to judge, the run status is unknown and fails closed.

pytest --sharpit --sharpit-report=sharpit-report.json --sharpit-junit=sharpit-junit.xml

Read Pytest plugin and Test report for options, gates, and CI examples.

Documentation

The full documentation is at https://ffroliva.github.io/sharpit/:

• Activation: when sharpit turns on, and why a plain uvicorn app:app gives 404
• Panels: what each panel shows
• Pytest plugin: CI gates for queries, N+1, exceptions, and advisors
• Test report: the sharpit-report/1 JSON schema and JUnit XML
• SQL sources: tracing SQLAlchemy and raw sqlite3
• MCP for AI agents: the read-only MCP endpoint and its 18 tools
• Settings: every environment variable and install() keyword
• Safety model: local-only guard, tokens, masking, proxies and workers
• How it works and Deviations from BootUI

License

Apache License 2.0. See LICENSE and NOTICE. sharpit is derived from BootUI, Copyright Julien Dubois.