Open-source project
django-commons/django-debug-toolbar avatar
django-commons/django-debug-toolbar

Django Debug Toolbar 8.0.0: Django 5.2 or newer only, experimental async views, and no concurrent requests

A configurable set of panels that display various debug information about the current request/response.

8,378 stars1,122 forksPythonBSD-3-Clause

At a glance

What is it?
django-debug-toolbar adds a set of configurable panels to Django pages that show debug information about the current request and response. Version 8.0.0 requires Django 5.2 or newer and Python 3.10 or newer, and its support for async views is still marked experimental.
Who is it for?
Django Debug Toolbar is the default choice for inspecting a request and response inside a Django project running Django 5.2 or newer on Python 3.10 or newer. It is the wrong tool for debugging behaviour that depends on concurrent requests, and async projects should treat its support as experimental.
Can I use it commercially?
Yes. BSD-3-Clause is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
Is it still maintained?
Yes. The repository last received commits 1 day ago.
What is it written in?
Mainly Python, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 21, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • django-commons/django-debug-toolbar8,378 ★ · +0
Star history
Repository2026-10-072026-11-21
django-commons/django-debug-toolbar8.4k8.4k

0 Stars in the last 45 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

Panels that summarise the request and expand on click

The toolbar is a configurable set of panels. Each one displays a piece of debug information about the current request and response, and clicking a panel opens more detail about its content. The screenshot in the repository, generated by `example/screenshot.py`, shows the toolbar rendered over a page of the bundled example app. Beyond the panels shipped in the `debug_toolbar` package, third-party panels contributed by the community can be added.

The toolbar has a long history. Rob Hudson created it in August 2008, and many contributors have developed it since. The project now sits under the django-commons organisation on GitHub, with the documentation, including installation and configuration, hosted on Read the Docs. The package declares two runtime dependencies in pyproject.toml: `django>=5.2` and `sqlparse>=0.2`. It is released under the BSD license, the same license Django itself uses, and is classified as Production/Stable.

Version 8.0.0 sets a floor of Django 5.2 and Python 3.10

The current stable release is 8.0.0, tagged on 2026-09-01. It works on Django 5.2.0 and newer. The pyproject.toml classifiers name Django 5.2, 6.0 and 6.1, and Python 3.10 through 3.15, with `requires-python = ">=3.10"`.

The consequence for older projects is direct. A codebase still on a Django release below 5.2, or on Python 3.9, cannot use 8.0.0 and has to stay on an older toolbar release until the project itself is upgraded. Before that, the 7.x line shipped 7.1.0 on 2026-08-10 and 7.1.1 on 2026-08-14, and a major version bump three weeks later is a signal to read the changelog before upgrading rather than after. The changelog lives on Read the Docs, linked from pyproject.toml as `urls.Changelog`. The repository itself is active: it is not archived, and the last push was on 2026-11-02.

Async views are experimental and concurrent requests are not handled

The toolbar has experimental support for Django's asynchronous views. The project is explicit about what is missing: the Debug Toolbar still lacks the capability for handling concurrent requests, and it asks users who hit problems to report them on the issue tracker.

For a developer, that limit shapes what the toolbar can show. If you are chasing a bug that only appears when two requests overlap, such as a race on shared state or a problem under an ASGI server serving several requests at once, the toolbar is not built to capture that situation, and its output for overlapping requests is not something to trust. Use it for one request at a time.

The repository does exercise the async path: the example app ships `example/asgi.py` and an `example/async_/` package, and the Makefile has an `example_async` target that starts the app with Daphne:

bash
daphne example.asgi:application

Daphne appears in the dev dependency group with the comment that it is there for async in the example app.

python setup.py install now exits with an error

The repository still contains a setup.py, but it exists only to stop one installation method. Running it prints a banner reading Unsupported installation method and exits with status 1. The message tells you what to use instead:

bash
python -m pip install .

The package builds with Hatchling, declared as the build backend in pyproject.toml, and its version is dynamic rather than written into the file. If you have an old deployment script or a vendored install step that calls `python setup.py install` on a checkout of the toolbar, it will fail outright rather than install a stale copy, so switch it to pip. For normal use, the package is published on PyPI as django-debug-toolbar, and the installation and configuration steps are on the Read the Docs site rather than in README.rst. The README itself gives no install command, so do not expect a copy-and-paste quick start from the repository front page.

The example project doubles as a playground with a throwaway superuser

The `example/` directory is a small Django project with its own `settings.py`, `urls.py`, `views.py`, `models.py`, migrations, templates, static files and an SQLite file, `example/example.db`. The Makefile `example` target migrates it, creates a superuser, and starts the development server. The last step is:

bash
python example/manage.py runserver

The superuser is created non-interactively with `DJANGO_SUPERUSER_PASSWORD=p`, using your shell `$(USER)` as the username and a mailinator.com address. That is fine for a local sandbox and a reason never to point this target at a database you care about. The example has its own tests, run through `example_test`:

bash
python example/manage.py test example

This is the quickest way to see panels on a working page before wiring the toolbar into your own project, since it removes your settings from the list of things that might be wrong when the toolbar does not appear.

Python tests, Selenium tests and a Node 24 Vitest suite

The test setup has three layers. The main suite runs Django's test runner against `tests.settings`, and the `test_selenium` target reruns it with `DJANGO_SELENIUM_TESTS=true` to include frontend tests written with Selenium. The coverage target runs Python with `-b -W always` so warnings surface during the run, then writes text, HTML and XML reports. The README badge reports 94 percent coverage.

The toolbar's browser-side code has its own JavaScript test suite. The repository root carries a package.json whose only script is `vitest`, with `@vitest/browser-playwright` and `@vitest/coverage-istanbul` as dev dependencies, plus a `vitest.config.js` and a `biome.json`. That package.json requires Node 24.0.0 or newer and npm 11.0.0 or newer. None of this affects people who install the toolbar from PyPI, but contributors who touch the frontend need a recent Node toolchain alongside Python, and an older Node install will not satisfy the declared engines.

Translations flow through Transifex with a ten percent threshold

The interface strings are translated through Transifex, configured in the `.tx/` directory. The Makefile has two targets for this. `translatable_strings` regenerates the English `.po` file inside `debug_toolbar` with `makemessages -l en --no-obsolete` and reminds the maintainer to push with `tx push -s`. `update_translations` pulls every language with a minimum completion threshold and compiles them:

bash
tx pull -a --minimum-perc=10

The practical effect is that a language only needs ten percent of its strings translated to be pulled into the package, so a shipped locale can still have most of its strings untranslated. If your language is one of them, the place to help is Transifex, where the maintainers pull translations from. CONTRIBUTING.md, CODE_OF_CONDUCT.md and SECURITY.md sit at the repository root for anyone who wants to contribute or report a vulnerability.

Editorial conclusion

Django Debug Toolbar is the default choice for inspecting a request and response inside a Django project running Django 5.2 or newer on Python 3.10 or newer. It is the wrong tool for debugging behaviour that depends on concurrent requests, and async projects should treat its support as experimental. Before upgrading to 8.0.0, check your Django version against the 5.2 floor and read the changelog on Read the Docs.

Frequently asked questions

what is django debug toolbar

It is a configurable set of panels for Django that display debug information about the current request and response; clicking a panel shows more detail about its content.

how to install django debug toolbar

The package is published on PyPI as django-debug-toolbar, and the installation and configuration steps are on django-debug-toolbar.readthedocs.io. From a source checkout, use python -m pip install . because python setup.py install is no longer supported.

How do I use the Django Debug Toolbar?

Once it is configured, the toolbar shows panels with debug information about the current request and response, and clicking a panel displays more details. Version 8.0.0 requires Django 5.2 or newer.

Official sources

  1. django-commons/django-debug-toolbar on GitHub
  2. License: BSD-3-Clause
  3. Project website
  4. README
  5. Releases
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/django-commons-django-debug-toolbar.svg)](https://hysenlabs.com/projects/django-commons-django-debug-toolbar)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/django-commons-django-debug-toolbar.svg)](https://hysenlabs.com/projects/django-commons-django-debug-toolbar)

Was this useful?