========================== django-debug-toolbar-force

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

.. image:: https://img.shields.io/pypi/v/django-debug-toolbar-force.svg :target: https://pypi.python.org/pypi/django-debug-toolbar-force :alt: PyPI Version

.. image:: https://img.shields.io/pypi/pyversions/django-debug-toolbar-force.svg :target: https://pypi.python.org/pypi/django-debug-toolbar-force/ :alt: Supported Python versions

.. image:: https://github.com/barseghyanartur/django-debug-toolbar-force/workflows/test/badge.svg :target: https://github.com/barseghyanartur/django-debug-toolbar-force/actions?query=workflow%3Atest :alt: Build Status

.. image:: https://readthedocs.org/projects/django-debug-toolbar-force/badge/?version=latest :target: http://django-debug-toolbar-force.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. image:: https://img.shields.io/badge/license-GPL--2.0--only%20OR%20LGPL--2.1--or--later-blue.svg :target: https://github.com/barseghyanartur/django-debug-toolbar-force/#License :alt: GPL-2.0-only OR LGPL-2.1-or-later

.. image:: https://coveralls.io/repos/github/barseghyanartur/django-debug-toolbar-force/badge.svg?branch=master :target: https://coveralls.io/github/barseghyanartur/django-debug-toolbar-force?branch=master :alt: 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 <http://django-debug-toolbar-force.readthedocs.io/>_.

Installation

(1) Install latest stable version from PyPI:

.. code-block:: sh

    pip install django-debug-toolbar-force

or latest stable version from GitHub:

.. code-block:: sh

    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).

.. code-block:: python

    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.

.. code-block:: text

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

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

.. code-block:: text

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

Testing

Simply type:

.. code-block:: sh

pytest -vvv

or use tox:

.. code-block:: sh

tox

or use tox to check specific env:

.. code-block:: sh

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 <https://github.com/barseghyanartur/django-debug-toolbar-force/issues>_.

Author

Artur Barseghyan artur.barseghyan@gmail.com