Skip to main content

A debug toolbar for FastAPI.

Project description

FastAPI Debug Toolbar

FastAPI Debug Toolbar

🐞A debug toolbar for FastAPI based on the original django-debug-toolbar.🐞
Swagger UI & GraphQL are supported.

Test Coverage Codacy Package version


Documentation: https://fastapi-debug-toolbar.domake.io


Installation

pip install fastapi-debug-toolbar

Quickstart

Add DebugToolbarMiddleware middleware to your FastAPI application:

from debug_toolbar.middleware import DebugToolbarMiddleware
from fastapi import FastAPI

app = FastAPI(debug=True)
app.add_middleware(DebugToolbarMiddleware)

SQLAlchemy

Please make sure to use the "Dependency Injection" system as described in the FastAPI docs and add the SQLAlchemyPanel to your panel list:

app.add_middleware(
    DebugToolbarMiddleware,
    panels=["debug_toolbar.panels.sqlalchemy.SQLAlchemyPanel"],
)

Tortoise ORM

Add the TortoisePanel to your panel list:

app.add_middleware(
    DebugToolbarMiddleware,
    panels=["debug_toolbar.panels.tortoise.TortoisePanel"],
)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastapi_debug_toolbar-0.6.3.tar.gz (26.9 kB view details)

Uploaded Source

Built Distribution

fastapi_debug_toolbar-0.6.3-py3-none-any.whl (42.9 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_debug_toolbar-0.6.3.tar.gz.

File metadata

  • Download URL: fastapi_debug_toolbar-0.6.3.tar.gz
  • Upload date:
  • Size: 26.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for fastapi_debug_toolbar-0.6.3.tar.gz
Algorithm Hash digest
SHA256 15ff6828f9432c786af39f23a2d814ef2af516964b5a9a856444de135a78b2af
MD5 27488874f6ac03076b2b0cbaf305871d
BLAKE2b-256 ace6c228493e929eeb2b9e61806a63e78c3c0bec4e22ddee99f321ffba4fa64a

See more details on using hashes here.

File details

Details for the file fastapi_debug_toolbar-0.6.3-py3-none-any.whl.

File metadata

File hashes

Hashes for fastapi_debug_toolbar-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 077b5ffeb10426c49387ef090cf307a316d5c71c69bbffe270d9898d2554429e
MD5 cb4a62dda6f8234a5ce3e008242b12ca
BLAKE2b-256 a709b01c8c60d608e93faa257a9a3fc9a9739c70c9ac926edfbbe92baebbf33b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page