Skip to content

barseghyanartur/django-debug-toolbar-force

Repository files navigation

django-debug-toolbar-force

Show django-debug-toolbar in non- or partial-HTML views.

PyPI Version Supported Python versions Build Status Documentation Status GPL-2.0-only OR LGPL-2.1-or-later Coverage

Prerequisites

  • Python 3.7, 3.8, 3.9, 3.10 and 3.11.
  • Django 2.2, 3.0, 3.1, 3.2, 4.0 and 4.1.
  • django-debug-toolbar (version depends on your Django version).

Documentation

Documentation is available on Read the Docs.

Installation

  1. Install latest stable version from PyPI:

    pip install django-debug-toolbar-force

    or latest stable version from GitHub:

    pip install https://github.com/barseghyanartur/django-debug-toolbar-force/archive/stable.tar.gz
  2. Add debug_toolbar_force.middleware.ForceDebugToolbarMiddleware to MIDDLEWARE of the your projects' Django settings (you would typically do that in your dev settings only).

    MIDDLEWARE += (
        "debug_toolbar.middleware.DebugToolbarMiddleware",
        "debug_toolbar_force.middleware.ForceDebugToolbarMiddleware",
    )

Usage

In your browser, visit a non-HTML view and append ?debug-toolbar at the end.

GET http://localhost:8000/foo/json-view/?debug-toolbar

Could be extremely handy for optimising endpoints of the Django REST Framework using browsable API.

GET http://localhost:8000/api/some-drf-endpoint/?format=json&debug-toolbar

Testing

Simply type:

pytest -vvv

or use tox:

tox

or use tox to check specific env:

tox -e py310

License

GPL-2.0-only OR LGPL-2.1-or-later

Support

For any security issues contact me at the e-mail given in the Author section.

For overall issues, go to GitHub.

Author

Artur Barseghyan <[email protected]>