fastapi-debug-toolbar


Namefastapi-debug-toolbar JSON
Version 0.6.0 PyPI version JSON
download
home_page
SummaryA debug toolbar for FastAPI.
upload_time2024-02-13 05:23:16
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords debug fastapi profiling
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # ![FastAPI](https://raw.githubusercontent.com/mongkok/fastapi-debug-toolbar/main/debug_toolbar/statics/img/icon-green.svg) Debug Toolbar

<p align="center">
    <a href="https://fastapi-debug-toolbar.domake.io">
        <img src="https://user-images.githubusercontent.com/5514990/131232994-621774a8-1662-468d-87d8-2199b93387d6.gif" alt="FastAPI Debug Toolbar">
    </a>
</p>
<p align="center">
    <em>🐞A debug toolbar for FastAPI based on the original django-debug-toolbar.🐞</em>
    <br><em><b>Swagger UI</b> & <b>GraphQL</b> are supported.</em>
</p>
<p align="center">
    <a href="https://github.com/mongkok/fastapi-debug-toolbar/actions">
        <img src="https://github.com/mongkok/fastapi-debug-toolbar/actions/workflows/test-suite.yml/badge.svg" alt="Test">
    </a>
    <a href="https://codecov.io/gh/mongkok/fastapi-debug-toolbar">
        <img src="https://img.shields.io/codecov/c/github/mongkok/fastapi-debug-toolbar?color=%2334D058" alt="Coverage">
    </a>
    <a href="https://www.codacy.com/gh/mongkok/fastapi-debug-toolbar/dashboard">
        <img src="https://app.codacy.com/project/badge/Grade/e9d8ba3973264424a3296016063b4ab5" alt="Codacy">
    </a>
    <a href="https://pypi.org/project/fastapi-debug-toolbar">
        <img src="https://img.shields.io/pypi/v/fastapi-debug-toolbar" alt="Package version">
    </a>
</p>


---

**Documentation**: [https://fastapi-debug-toolbar.domake.io](https://fastapi-debug-toolbar.domake.io)

---

## Installation

```sh
pip install fastapi-debug-toolbar
```

## Quickstart

Add `DebugToolbarMiddleware` middleware to your FastAPI application:

```py
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](https://fastapi.tiangolo.com/tutorial/sql-databases/#create-a-dependency) and add the `SQLAlchemyPanel` to your panel list:

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

## Tortoise ORM

Add the `TortoisePanel` to your panel list:

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

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "fastapi-debug-toolbar",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "debug,fastapi,profiling",
    "author": "",
    "author_email": "Dani <dani@domake.io>",
    "download_url": "https://files.pythonhosted.org/packages/26/5a/24d9fd053b26d9e9ca6eb24fed17363aac6b92a7d4ac727b6905e18cdb88/fastapi_debug_toolbar-0.6.0.tar.gz",
    "platform": null,
    "description": "# ![FastAPI](https://raw.githubusercontent.com/mongkok/fastapi-debug-toolbar/main/debug_toolbar/statics/img/icon-green.svg) Debug Toolbar\n\n<p align=\"center\">\n    <a href=\"https://fastapi-debug-toolbar.domake.io\">\n        <img src=\"https://user-images.githubusercontent.com/5514990/131232994-621774a8-1662-468d-87d8-2199b93387d6.gif\" alt=\"FastAPI Debug Toolbar\">\n    </a>\n</p>\n<p align=\"center\">\n    <em>\ud83d\udc1eA debug toolbar for FastAPI based on the original django-debug-toolbar.\ud83d\udc1e</em>\n    <br><em><b>Swagger UI</b> & <b>GraphQL</b> are supported.</em>\n</p>\n<p align=\"center\">\n    <a href=\"https://github.com/mongkok/fastapi-debug-toolbar/actions\">\n        <img src=\"https://github.com/mongkok/fastapi-debug-toolbar/actions/workflows/test-suite.yml/badge.svg\" alt=\"Test\">\n    </a>\n    <a href=\"https://codecov.io/gh/mongkok/fastapi-debug-toolbar\">\n        <img src=\"https://img.shields.io/codecov/c/github/mongkok/fastapi-debug-toolbar?color=%2334D058\" alt=\"Coverage\">\n    </a>\n    <a href=\"https://www.codacy.com/gh/mongkok/fastapi-debug-toolbar/dashboard\">\n        <img src=\"https://app.codacy.com/project/badge/Grade/e9d8ba3973264424a3296016063b4ab5\" alt=\"Codacy\">\n    </a>\n    <a href=\"https://pypi.org/project/fastapi-debug-toolbar\">\n        <img src=\"https://img.shields.io/pypi/v/fastapi-debug-toolbar\" alt=\"Package version\">\n    </a>\n</p>\n\n\n---\n\n**Documentation**: [https://fastapi-debug-toolbar.domake.io](https://fastapi-debug-toolbar.domake.io)\n\n---\n\n## Installation\n\n```sh\npip install fastapi-debug-toolbar\n```\n\n## Quickstart\n\nAdd `DebugToolbarMiddleware` middleware to your FastAPI application:\n\n```py\nfrom debug_toolbar.middleware import DebugToolbarMiddleware\nfrom fastapi import FastAPI\n\napp = FastAPI(debug=True)\napp.add_middleware(DebugToolbarMiddleware)\n```\n\n## SQLAlchemy\n\nPlease make sure to use the *\"Dependency Injection\"* system as described in the [FastAPI docs](https://fastapi.tiangolo.com/tutorial/sql-databases/#create-a-dependency) and add the `SQLAlchemyPanel` to your panel list:\n\n```py\napp.add_middleware(\n    DebugToolbarMiddleware,\n    panels=[\"debug_toolbar.panels.sqlalchemy.SQLAlchemyPanel\"],\n)\n```\n\n## Tortoise ORM\n\nAdd the `TortoisePanel` to your panel list:\n\n```py\napp.add_middleware(\n    DebugToolbarMiddleware,\n    panels=[\"debug_toolbar.panels.tortoise.TortoisePanel\"],\n)\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A debug toolbar for FastAPI.",
    "version": "0.6.0",
    "project_urls": {
        "changelog": "https://fastapi-debug-toolbar.domake.io/changelog/",
        "documentation": "https://fastapi-debug-toolbar.domake.io",
        "homepage": "https://github.com/mongkok/fastapi-debug-toolbar",
        "repository": "https://github.com/mongkok/fastapi-debug-toolbar"
    },
    "split_keywords": [
        "debug",
        "fastapi",
        "profiling"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e0eac574fa0c6e848f9c9dc8f540912e12eb79771a7c76340773cae6f6022900",
                "md5": "948fa06da426b1f8f3556cdca3938cb9",
                "sha256": "c23a150b34e5bf289650573afaafd09674bb5e8faed8937ec39ee08017677478"
            },
            "downloads": -1,
            "filename": "fastapi_debug_toolbar-0.6.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "948fa06da426b1f8f3556cdca3938cb9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 42456,
            "upload_time": "2024-02-13T05:23:15",
            "upload_time_iso_8601": "2024-02-13T05:23:15.049620Z",
            "url": "https://files.pythonhosted.org/packages/e0/ea/c574fa0c6e848f9c9dc8f540912e12eb79771a7c76340773cae6f6022900/fastapi_debug_toolbar-0.6.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "265a24d9fd053b26d9e9ca6eb24fed17363aac6b92a7d4ac727b6905e18cdb88",
                "md5": "4a07450a24014f1d83fee535f3a47e22",
                "sha256": "b66db0ef8fc85bbb57c8484bf9c576018ecdb9f28e5d802b79a6cbb4fa7b7ca8"
            },
            "downloads": -1,
            "filename": "fastapi_debug_toolbar-0.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4a07450a24014f1d83fee535f3a47e22",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 26738,
            "upload_time": "2024-02-13T05:23:16",
            "upload_time_iso_8601": "2024-02-13T05:23:16.935770Z",
            "url": "https://files.pythonhosted.org/packages/26/5a/24d9fd053b26d9e9ca6eb24fed17363aac6b92a7d4ac727b6905e18cdb88/fastapi_debug_toolbar-0.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-13 05:23:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mongkok",
    "github_project": "fastapi-debug-toolbar",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "fastapi-debug-toolbar"
}
Elapsed time: 0.18043s