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"],
)

Project details


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.2.0.tar.gz (29.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastapi_debug_toolbar-0.2.0-py3-none-any.whl (44.2 kB view details)

Uploaded Python 3

File details

Details for the file fastapi-debug-toolbar-0.2.0.tar.gz.

File metadata

  • Download URL: fastapi-debug-toolbar-0.2.0.tar.gz
  • Upload date:
  • Size: 29.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.6 Linux/5.8.0-1039-azure

File hashes

Hashes for fastapi-debug-toolbar-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b37c1bb54ada3c5e372b539bcd5313c4c1b7a4929fe040608b64403f232252c0
MD5 78b9f40be21fc84d01b33795874b7ce0
BLAKE2b-256 83d1ad27f1ff31ccce8f58585e3c4129cbe02b761e33d8bc8c3ed4207234152c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fastapi_debug_toolbar-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd93546175aa8b93dd3db769a4e69704edc379cf80ba14b962006d38a0534a89
MD5 656f047016ff952cf3d1c3c81b5fcca4
BLAKE2b-256 a0dbbc3bda2fe03a73a6cc2be5181adabea0d11bb0747557558fbb8c0971e849

See more details on using hashes here.

Supported by

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