Skip to content

Conversation

pyup-bot
Copy link
Collaborator

This PR updates django-debug-toolbar from 3.4.0 to 6.0.0.

Changelog

6.0.0

Description

The v6.0.0 release of Django Debug Toolbar significantly revamps how panels for the toolbar work. Each panel will now persist its data in a store. A store can either be backed by various backends. The toolbar will support a memory and database backend to start.

**The toolbar is now using Django's `SafeExceptionReporterFilter.cleanse_setting()` function to filter out sensitive information.** Some data will be replaced with `"********************"`. This is because the toolbar could be configured to write the request information to a persistent store such as a cache or database.

Django applications with basic installations are backwards compatible with this change. If there are hooks into the internals of the toolbar, such as `DebugToolbar.store_id` then it will be backwards incompatible.

Third-party panels will need updating. Any data that is stored in `record_stats` will need to be fetched back out from `self.get_stats()` before being able to be rendered. This is to support loading an instance of the toolbar from persisted data. A simple example of this transition can be found in `debug_toolbar/panels/cache.py` in [PR 2138](https://github.com/django-commons/django-debug-toolbar/pull/2138)

How to upgrade

- **Basic usages require no changes**
- If you have a custom panel, you'll need to adjust `record_stats` and use `self.get_stats()` to fetch data for rendering
- If you'd like to use the database store, see [`TOOLBAR_STORE_CLASS`](https://django-debug-toolbar.readthedocs.io/en/latest/configuration.html#:~:text=TOOLBAR_STORE_CLASS) for more info

Why did the internals change?

The Django Debug Toolbar is a popular package we did not want to block the community from pursuing the async path for Django applications. Writing the request data to a store better positions the toolbar for async projects. It also opens the door for it being [usable in production](https://github.com/django-commons/django-debug-toolbar/issues/1435) as well with [API integrations](https://github.com/django-commons/django-debug-toolbar/issues/2048).

What's Changed
* Log serialization warning when a panel errors. by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/1810
* Improve clarity of record_stats for serialization. by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/1965
* Update serializable branch with main by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2072
* Remove pin for django-csp. by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2132
* Fixes 2073 -- Added DatabaseStore for persistent debug data storage. by dr-rompecabezas in https://github.com/django-commons/django-debug-toolbar/pull/2121
* Disabled document.cookie linter by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2139
* Added check for pytest as test runner for IS_RUNNING_TESTS. by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2137
* Remove Type Hints from CspRenderingTestCase by andoriyaprashant in https://github.com/django-commons/django-debug-toolbar/pull/2144
* Add show_toolbar_with_docker function for Docker IP handling by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2153
* Support serializable toolbar by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2138
* Deduplicate staticfiles by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2155
* Fixes 2158 -- Made static file objects orderable by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2161
* Fixes 2160 -- Corrected links to static files by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2162
* Fixes 2151 -- Forwarded args and kwargs in URLMixin.url by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2163
* Fixes 2159 -- Do not HTML-escape traces in the cache and profiling panel by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2164

**Full Changelog**: https://github.com/django-commons/django-debug-toolbar/compare/5.2.0...6.0.0

Acknowlegements

Thank you to all the contributors who made this release possible. Thank you to robhudson, matthiask, tim-schilling, salty-ivy and dr-rompecabezas for their support, development and reviews of the serializable toolbar changes. A special shout-out to matthiask for leading the Djangonaut Space Session 4 team of dr-rompecabezas, andoriyaprashant and blingblin-g.

5.2.0

What's Changed
* Enhance RedirectsPanel with customizable redirect response hook by blingblin-g in https://github.com/django-commons/django-debug-toolbar/pull/2104
* Sanitize sensitive variables in RequestPanel by dr-rompecabezas in https://github.com/django-commons/django-debug-toolbar/pull/2105
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/django-commons/django-debug-toolbar/pull/2112
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/django-commons/django-debug-toolbar/pull/2115
* Dark Mode Conflict in Pygments Fixed by andoriyaprashant in https://github.com/django-commons/django-debug-toolbar/pull/2111
* Fix 2109: Recursively unwrap loaders to support template partials by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2117
* Refs 2096: The theme selector now controls all colors by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2116
* Format the templates using djade by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2120
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/django-commons/django-debug-toolbar/pull/2122
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/django-commons/django-debug-toolbar/pull/2126
* Keep pannel close button accessible with external styles by TomHall2020 in https://github.com/django-commons/django-debug-toolbar/pull/2128
* Add CSS resets for height and min-height by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2130

New Contributors
* TomHall2020 made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2128

**Full Changelog**: https://github.com/django-commons/django-debug-toolbar/compare/5.1.0...5.2.0

5.1.0

What's Changed
* Update version for sigstore action to full version. by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2056
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/django-commons/django-debug-toolbar/pull/2053
* Add Django 5.2 to tox matrix by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2064
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/django-commons/django-debug-toolbar/pull/2063
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/django-commons/django-debug-toolbar/pull/2067
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/django-commons/django-debug-toolbar/pull/2077
* Update package metadata to include well-known labels by andoriyaprashant in https://github.com/django-commons/django-debug-toolbar/pull/2078
* Pinned django-csp's version used for our tests by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2084
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/django-commons/django-debug-toolbar/pull/2080
* Add resources section to the documentation by dr-rompecabezas in https://github.com/django-commons/django-debug-toolbar/pull/2081
* Make show toolbar callback function async/sync compatible. by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2066
* Fix last name typo in resources.rst by dr-rompecabezas in https://github.com/django-commons/django-debug-toolbar/pull/2085
* Add link to contributing documentation in CONTRIBUTING.md by blingblin-g in https://github.com/django-commons/django-debug-toolbar/pull/2086
* Pull translations from transifex by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2089
* Replace ESLint and prettier with biome by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2090
* Enable a few of the disabled biome rules  by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2091
* Replace forEach loops with for...of loops by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2093
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/django-commons/django-debug-toolbar/pull/2095
* Add help command to the Makefile by mrbazzan in https://github.com/django-commons/django-debug-toolbar/pull/2094
* Replace DebugConfiguredStorage with URLMixin in staticfiles panel by dr-rompecabezas in https://github.com/django-commons/django-debug-toolbar/pull/2097
* Fix for exception-unhandled "forked" Promise chain by karolyi in https://github.com/django-commons/django-debug-toolbar/pull/2101
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/django-commons/django-debug-toolbar/pull/2102
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/django-commons/django-debug-toolbar/pull/2107
* Fix Dark Mode Conflict in Pygments by andoriyaprashant in https://github.com/django-commons/django-debug-toolbar/pull/2108
* Refactor on csp_nonce usage with django-csp by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2088

New Contributors
* andoriyaprashant made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2078
* dr-rompecabezas made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2081
* blingblin-g made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2086
* mrbazzan made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2094

**Full Changelog**: https://github.com/django-commons/django-debug-toolbar/compare/5.0.1...5.1.0

5.0.1

What's Changed

There were no functional changes in this version.

PRs

* Update release workflows to latest trusted publisher GHA. by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2054


**Full Changelog**: https://github.com/django-commons/django-debug-toolbar/compare/5.0.0...5.0.1

5.0.0

What's Changed

Please note that Django Debug Toolbar has now moved into the Django Commons organization.

Changelog

* Added Python 3.13 to the CI matrix.
* Removed support for Python 3.8 as it has reached end of life.
* Converted to Django Commons PyPI release process.
* Fixed a crash which occurred when using non-``str`` static file values.
* Documented experimental async support.
* Improved troubleshooting doc for incorrect mime types for .js static files
* Support async applications and ASGI from
`Google Summer of Code Project 2024
<https://summerofcode.withgoogle.com/programs/2024/projects/iXVvyGYp>`__.
* Added Django 5.1 to the CI matrix.
* Added support for the ``LoginRequiredMiddleware`` introduced in Django 5.1.
* Support select and explain buttons for ``UNION`` queries on PostgreSQL.
* Fixed internal toolbar requests being instrumented if the Django setting
``FORCE_SCRIPT_NAME`` was set.
* Increase opacity of show Debug Toolbar handle to improve accessibility.
* Changed the ``RedirectsPanel`` to be async compatible.
* Increased the contrast of text with dark mode enabled.
* Add translations for Bulgarian and Korean.
* Update translations for several languages.
* Include new translatable strings for translation.
* Fixed a crash which happened in the fallback case when session keys cannot be
sorted.

PRs
* Async compatible debug-toolbar middleware by salty-ivy in https://github.com/django-commons/django-debug-toolbar/pull/1938
* Add async tests by salomvary in https://github.com/django-commons/django-debug-toolbar/pull/1835
* Update installation.rst by Dr-Bernard in https://github.com/django-commons/django-debug-toolbar/pull/1967
* Make toolbar compatible with `FORCE_SCRIPT_NAME` by dmartin in https://github.com/django-commons/django-debug-toolbar/pull/1970
* Support select and explain for UNION queries by friedelwolff in https://github.com/django-commons/django-debug-toolbar/pull/1972
* Override `DEBUG=True` in async middleware compatibility tests by salty-ivy in https://github.com/django-commons/django-debug-toolbar/pull/1977
* Quick hack for including csp_nonces from requests into script tags by karolyi in https://github.com/django-commons/django-debug-toolbar/pull/1975
* Slightly increase opacity of debug toolbar button by jribbens in https://github.com/django-commons/django-debug-toolbar/pull/1982
* Async compatible redirect panel by salty-ivy in https://github.com/django-commons/django-debug-toolbar/pull/1976
* :wrench: update translation for Persian language by elias-ebrahimpour in https://github.com/django-commons/django-debug-toolbar/pull/1873
* Add a paragraph describing our stance on Python typing by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/1979
* Dark mode text needs higher contrast by myou1985 in https://github.com/django-commons/django-debug-toolbar/pull/1987
* Switch to Django Commons code of conduct by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/1978
* Update translations by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/1984
* Make Panels non async  by default by salty-ivy in https://github.com/django-commons/django-debug-toolbar/pull/1990
* Async compatible `StaticFilesPanel` by salty-ivy in https://github.com/django-commons/django-debug-toolbar/pull/1983
* Refs 1668: Fixed the unsortable session keys fallback by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/1994
* Add Django 5.1 to the CI matrix by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/1995
* Use Heading-4 for PR template for screen-readers. by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/1999
* Async compatible `HistoryPanel` by salty-ivy in https://github.com/django-commons/django-debug-toolbar/pull/1991
* Async compatible `SQLPanel` by salty-ivy in https://github.com/django-commons/django-debug-toolbar/pull/1993
* Correct "middleware" typos by korverdev in https://github.com/django-commons/django-debug-toolbar/pull/2003
* add support for LoginRequiredMiddleware with login_not_required decor… by dulmandakh in https://github.com/django-commons/django-debug-toolbar/pull/2005
* Async integration tests by salty-ivy in https://github.com/django-commons/django-debug-toolbar/pull/2001
* Modernize Python type hints and string formatting by cclauss in https://github.com/django-commons/django-debug-toolbar/pull/2012
* Adding in support for Python 3.13 by abeed-avayu in https://github.com/django-commons/django-debug-toolbar/pull/2014
* Fix 2011: Test the divisor, not the dividend for zero by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2015
* Update Installation warning doc  by salty-ivy in https://github.com/django-commons/django-debug-toolbar/pull/2019
* Convert to Django Commons pypi-github release process by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2017
* The static files panel shouldn't choke on unexpected data types by matthiask in https://github.com/django-commons/django-debug-toolbar/pull/2021
* Update references to point to django-commons repo by robhudson in https://github.com/django-commons/django-debug-toolbar/pull/2022
* Update pyupgrade's target version to Python 3.9 by ulgens in https://github.com/django-commons/django-debug-toolbar/pull/2024
* I added more explanations to the example/readme file. by jong-seoung in https://github.com/django-commons/django-debug-toolbar/pull/2027
* Adopt a basic security policy by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2040
* Fix whitespace view in code by thesayfulla in https://github.com/django-commons/django-debug-toolbar/pull/2043
* Documented experimental async support. by tim-schilling in https://github.com/django-commons/django-debug-toolbar/pull/2045
* Updated Troubleshooting documentation: simpler mimetype workaround for .js file by blep in https://github.com/django-commons/django-debug-toolbar/pull/2047

Google Summer of Code - Async project

This release contains the changes for async compatibility for the majority of panels. This is the result of the Google Summer of Code project by salty-ivy. A massive thank you 💚 and a round of applause 👏 is due to Aman!

New Contributors
* Dr-Bernard made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/1967
* dmartin made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/1970
* friedelwolff made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/1972
* karolyi made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/1975
* jribbens made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/1982
* elias-ebrahimpour made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/1873
* myou1985 made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/1987
* korverdev made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2003
* dulmandakh made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2005
* abeed-avayu made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2014
* robhudson made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2022
* ulgens made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2024
* jong-seoung made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2027
* thesayfulla made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2043
* blep made their first contribution in https://github.com/django-commons/django-debug-toolbar/pull/2047

**Full Changelog**: https://github.com/django-commons/django-debug-toolbar/compare/4.4.6...5.0.0

5.0.0alpha

Why 5.0 and why alpha?

Version 5.0 does not contain any backwards incompatible changes. Instead it should be more compatible with async Django projects. However, the change did require some reasonably sized changes to the middleware. This is a large enough change that we wanted it to be effectively communicated to users of the toolbar.

This release is an alpha because the async logic was tested, but we also understand that we haven't tested it in every scenario. We fully expect the project to continue to function extremely well in WSGI applications. For ASGI applications that are utilizing async, well, that's why it's an alpha 😁

What's Changed
* Async compatible debug-toolbar middleware by salty-ivy in https://github.com/jazzband/django-debug-toolbar/pull/1938
* Add async tests by salomvary in https://github.com/jazzband/django-debug-toolbar/pull/1835
* Update installation.rst by Dr-Bernard in https://github.com/jazzband/django-debug-toolbar/pull/1967
* Make toolbar compatible with `FORCE_SCRIPT_NAME` by dmartin in https://github.com/jazzband/django-debug-toolbar/pull/1970
* Support select and explain for UNION queries by friedelwolff in https://github.com/jazzband/django-debug-toolbar/pull/1972
* Override `DEBUG=True` in async middleware compatibility tests by salty-ivy in https://github.com/jazzband/django-debug-toolbar/pull/1977
* Quick hack for including csp_nonces from requests into script tags by karolyi in https://github.com/jazzband/django-debug-toolbar/pull/1975
* Slightly increase opacity of debug toolbar button by jribbens in https://github.com/jazzband/django-debug-toolbar/pull/1982
* Async compatible redirect panel by salty-ivy in https://github.com/jazzband/django-debug-toolbar/pull/1976
* :wrench: update translation for Persian language by elias-ebrahimpour in https://github.com/jazzband/django-debug-toolbar/pull/1873
* Add a paragraph describing our stance on Python typing by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1979
* Dark mode text needs higher contrast by myou1985 in https://github.com/jazzband/django-debug-toolbar/pull/1987
* Switch to Django Commons code of conduct by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1978
* Update translations by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1984
* Make Panels non async  by default by salty-ivy in https://github.com/jazzband/django-debug-toolbar/pull/1990
* Async compatible `StaticFilesPanel` by salty-ivy in https://github.com/jazzband/django-debug-toolbar/pull/1983
* Refs 1668: Fixed the unsortable session keys fallback by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1994
* Add Django 5.1 to the CI matrix by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1995
* Use Heading-4 for PR template for screen-readers. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1999
* Async compatible `HistoryPanel` by salty-ivy in https://github.com/jazzband/django-debug-toolbar/pull/1991
* Async compatible `SQLPanel` by salty-ivy in https://github.com/jazzband/django-debug-toolbar/pull/1993

New Contributors
* Dr-Bernard made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1967
* dmartin made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1970
* friedelwolff made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1972
* karolyi made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1975
* jribbens made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1982
* elias-ebrahimpour made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1873
* myou1985 made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1987

Google Summer of Code - Async project

This release contains the changes for async compatibility for the majority of panels. This is the result of the Google Summer of Code project by salty-ivy. A massive thank you 💚 and a round of applause 👏 is due to Aman!

**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/4.4.6...5.0.0-alpha

4.4.6

What's Changed
* Close 1509: Revert the infinite recursion fix, Django has changed the behavior by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1955
* Fixed order and grammatical number of panels in documentation by bkdekoning in https://github.com/jazzband/django-debug-toolbar/pull/1956
* Alerts panel: Only process HTML responses by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1960


**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/4.4.5...4.4.6

4.4.5

What's Changed

* Fix 1951: Do not crash if the 'alerts' key doesn't exist by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1953
* Only import the jinja2 instrumentation when jinja2 itself is importable by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1954


**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/4.4.4...4.4.5

4.4.4

What's Changed
* Check for for StreamingHttpResponse when generating stats in Alert by danjac in https://github.com/jazzband/django-debug-toolbar/pull/1946
* Actually use the Jinja2 template backend by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1882

New Contributors
* danjac made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1946

**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/4.4.3...4.4.4

4.4.3

What's Changed
* Fix overriding font-family for both light and dark themes by federicobond in https://github.com/jazzband/django-debug-toolbar/pull/1930
* Restore compatibility with iptools.IpRangeList by quinox in https://github.com/jazzband/django-debug-toolbar/pull/1929
* Limit the cases for E001 to likely scenarios by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1925
* Introduce debug_toolbar_urls to simplify installation by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1926
* Fixed 1682 -- alert user when using file field without proper encoding by bkdekoning in https://github.com/jazzband/django-debug-toolbar/pull/1933
* Remove rem units from svg by michjnich in https://github.com/jazzband/django-debug-toolbar/pull/1942

New Contributors
* quinox made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1929
* bkdekoning made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1933
* michjnich made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1942

**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/4.4.2...4.4.3

4.4.2

What's Changed
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/jazzband/django-debug-toolbar/pull/1909
* Avoid setting color-scheme on :root, we're only a guest on pages by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1923
* Add a section to the installation docs about running tests by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1921
* Version 4.4.2 by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1924


**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/4.4.1...4.4.2

4.4.1

What's changed

See [changelog for 4.4.1](https://github.com/jazzband/django-debug-toolbar/blob/main/docs/changes.rst#441-2024-05-26)

PRs merged
* Limit metadata version for Jazzband's release process by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1916

**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/4.4...4.4.1

4.4

**Note:** Version 4.4 (4.4.0) was not released to PyPI due to a metadata version incompatibility. Version 4.4.1 fixes that. 

What's changed

See [changelog for 4.4](https://github.com/jazzband/django-debug-toolbar/blob/main/docs/changes.rst#440-2024-05-26)

PRs merged
* Use url template tag for example URLs by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1879
* Keep GitHub Actions up to date with GitHub's Dependabot by cclauss in https://github.com/jazzband/django-debug-toolbar/pull/1876
* 1870 fix pre commit errors by elijah0kello in https://github.com/jazzband/django-debug-toolbar/pull/1884
* Show toolbar for docker's internal IP address by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1887
* Raise the minimum Django version to 4.2 by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1880
* 1847 improve handling when djdt views dont respond with json by elineda in https://github.com/jazzband/django-debug-toolbar/pull/1877
* Fix DeprecationWarnings about form default templates by pfouque in https://github.com/jazzband/django-debug-toolbar/pull/1878
* Add architecture documentation for the project. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1890
* Remove obsolete staticfiles check by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1894
* Make tox pass selenium environment variables by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1892
* Allow more control over tox Selenium tests by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1897
* Deprecate OBSERVE_REQUEST_CALLBACK setting by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1895
* Docs > Add a note on the profiling panel doc by elineda in https://github.com/jazzband/django-debug-toolbar/pull/1899
* 'djdt' is not a registered namespace 1405 by VeldaKiara in https://github.com/jazzband/django-debug-toolbar/pull/1889
* Remove unnecessary GitHub Graph info by jeffwidman in https://github.com/jazzband/django-debug-toolbar/pull/1910
* New coverage.yml for code coverage by salty-ivy in https://github.com/jazzband/django-debug-toolbar/pull/1912
* Dark mode support by TheRealVizard in https://github.com/jazzband/django-debug-toolbar/pull/1913
* Fix theme selenium integration test. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1915

New Contributors
* elijah0kello made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1884
* pfouque made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1878
* jeffwidman made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1910
* salty-ivy made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1912
* TheRealVizard made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1913

**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/4.3...4.4

4.3

What's Changed
* docs(panels): remove very old / outdated third-party panels by Zerotask in https://github.com/jazzband/django-debug-toolbar/pull/1825
* Add note on lack of async support to docs by salomvary in https://github.com/jazzband/django-debug-toolbar/pull/1829
* do not quote SQL params before passing them to mogrify by tkoschnick in https://github.com/jazzband/django-debug-toolbar/pull/1832
* panels(templates): avoid evaluating LazyObject by nijel in https://github.com/jazzband/django-debug-toolbar/pull/1833
* Support Django 5.0 by adamchainz in https://github.com/jazzband/django-debug-toolbar/pull/1839
* Add Python 3.12 to the test matrix. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1816
* Fix `utils.get_name_from_obj` proper view names by leandrodesouzadev in https://github.com/jazzband/django-debug-toolbar/pull/1846
* pyproject.toml: Work on the readability of ruff settings by cclauss in https://github.com/jazzband/django-debug-toolbar/pull/1850
* Switch to ruff format by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1852
* Fix 1858 -- Drop support for Django 4.0 by pauloxnet in https://github.com/jazzband/django-debug-toolbar/pull/1859
* Fix 1860 -- Update GitHub action versions by pauloxnet in https://github.com/jazzband/django-debug-toolbar/pull/1861
* Refactor is_project_func method for Windows compatibility by DraKen0009 in https://github.com/jazzband/django-debug-toolbar/pull/1857
* Configure ESLint using a JS file instead of JSON by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1868
* pre-commit-config: Upgrade ruff by cclauss in https://github.com/jazzband/django-debug-toolbar/pull/1869
* The djdt handle shouldn't be stuck at the top of the browser window initially 1853 by VeldaKiara in https://github.com/jazzband/django-debug-toolbar/pull/1871
* 1843 new ajax request resets whole view if historypanel is enabled by elineda in https://github.com/jazzband/django-debug-toolbar/pull/1872

New Contributors
* Zerotask made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1825
* salomvary made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1829
* tkoschnick made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1832
* nijel made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1833
* DraKen0009 made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1857
* VeldaKiara made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1871
* elineda made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1872

**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/4.2...4.3

4.2

What's Changed
* Fixed 1780 -- Adjusted system check to allow for nested template loa… by carltongibson in https://github.com/jazzband/django-debug-toolbar/pull/1783
* Include all files in sdist archives by mgorny in https://github.com/jazzband/django-debug-toolbar/pull/1785
* SQL panel work by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1786
* Use ruff for linting by WhyNotHugo in https://github.com/jazzband/django-debug-toolbar/pull/1781
* Minor testing cleanups by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1782
* Fix 1792: Lowercase all cookie keys, actually allow overriding the samesite value by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1793
* More rules for ruff by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1794
* Fix CI tests with MariaDB. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1797
* Switch StaticFilesPanel to use ContextVar. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1801
* Check JavaScript files content type. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1802
* Handle logging queries encoded as bytes under PostgreSQL by Lucidiot in https://github.com/jazzband/django-debug-toolbar/pull/1812
* Patch CursorWrapper dynamically to allow multiple base classes. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1820

New Contributors
* mgorny made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1785
* WhyNotHugo made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1781
* Lucidiot made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1812

**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/4.1...4.2

4.1

What's Changed
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/jazzband/django-debug-toolbar/pull/1755
* SQL query formatting improvements by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1752
* Use the new STORAGES setting in Django 4.2 by radwon in https://github.com/jazzband/django-debug-toolbar/pull/1759
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/jazzband/django-debug-toolbar/pull/1761
* Switch to sphinx 7's intersphinx_mapping usage. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1767
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/jazzband/django-debug-toolbar/pull/1766
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/jazzband/django-debug-toolbar/pull/1768
* Fix 1711 Improve installation page formats by pauloxnet in https://github.com/jazzband/django-debug-toolbar/pull/1772
* Don't try to undo cache method monkey patching by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1770
* Add theming support by GergelyKalmar in https://github.com/jazzband/django-debug-toolbar/pull/1760
* Replace deprecated GitHub Actions set-output commands by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1774
* Fix psycopg3 tests by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1773
* Replace time.time() with time.perf_counter() by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1777
* Bump coverage percentage to 94% by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1776
* D9pouces wsgi.multiprocess 1 by d9pouces in https://github.com/jazzband/django-debug-toolbar/pull/1765
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/jazzband/django-debug-toolbar/pull/1778
* Version 4.1.0 by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1779

New Contributors
* GergelyKalmar made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1760
* d9pouces made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1765

**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/4.0.0...4.1

4.0.0

* Added Django 4.2a1 to the CI.
* Dropped support for Python 3.7.
* Fixed PostgreSQL raw query with a tuple parameter during on explain.
* Use ``TOOLBAR_LANGUAGE`` setting when rendering individual panels
that are loaded via AJAX.
* Add decorator for rendering toolbar views with ``TOOLBAR_LANGUAGE``.
* Removed the logging panel. The panel's implementation was too complex, caused
memory leaks and sometimes very verbose and hard to silence output in some
environments (but not others). The maintainers judged that time and effort is
better invested elsewhere.
* Added support for psycopg3.
* When ``ENABLE_STACKTRACE_LOCALS`` is ``True``, the stack frames' locals dicts
will be converted to strings when the stack trace is captured rather when it
is rendered, so that the correct values will be displayed in the rendered
stack trace, as they may have changed between the time the stack trace was
captured and when it is rendered.

3.8.1

What's Changed
* fix: Simplify logic for Panel.enabled property by adamantike in https://github.com/jazzband/django-debug-toolbar/pull/1676
* Auto-update History panel with JavaScript fetch requests. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1685
* Improve the template_source view coverage a bit by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1688
* Support rerendering the toolbar on HTMX boosted pages. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1686
* Include panel scripts in content when RENDER_PANELS=True by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1689
* Fixed 1693 -- Run tests on python 3.11 by pauloxnet in https://github.com/jazzband/django-debug-toolbar/pull/1694
* Add divide by zero protection in timer.js  by SmailBestybay in https://github.com/jazzband/django-debug-toolbar/pull/1687
* Fixed 1695 - Run test on Python 3.11 for Django 4.1 by pauloxnet in https://github.com/jazzband/django-debug-toolbar/pull/1696
* Create one-time mouseup listener for each mousedown by scuml in https://github.com/jazzband/django-debug-toolbar/pull/1697
* Update package metadata by ofek in https://github.com/jazzband/django-debug-toolbar/pull/1690
* Validate and format pyproject.toml by hugovk in https://github.com/jazzband/django-debug-toolbar/pull/1700
* Drop Rob's email address in project config. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1699
* Fix highlighting on history panel by scuml in https://github.com/jazzband/django-debug-toolbar/pull/1698
* Allow Language Selection on the Toolbar by leandrodesouzadev in https://github.com/jazzband/django-debug-toolbar/pull/1703
* Attach handlers to djDebug instead of document by scuml in https://github.com/jazzband/django-debug-toolbar/pull/1702
* Formalize support for Python 3.11. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1713

New Contributors
* adamantike made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1676
* SmailBestybay made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1687
* ofek made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1690
* hugovk made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1700
* leandrodesouzadev made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1703

**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/3.7...3.8.1

3.8

This tag was not released due to a bug in the release job. Use 3.8.1

3.7

What's Changed
* Fix JS linting error from pre-commit. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1670
* Use system font stack in the toolbar by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1672
* Profiling panel improvements by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1669
* added functionality to keep unsort the session dict by ritiksoni00 in https://github.com/jazzband/django-debug-toolbar/pull/1673

New Contributors
* ritiksoni00 made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1673

**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/3.6...3.7

3.6

What's Changed
* Remove unused import from installation.rst by jonatron in https://github.com/jazzband/django-debug-toolbar/pull/1648
* Check if djdt-store-id is in all headers before usage. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1651
* docs: Fix a few typos by timgates42 in https://github.com/jazzband/django-debug-toolbar/pull/1652
* Make Selenium tests pass, hopefully by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1655
* Add Django 4.1 to classifiers by hramezani in https://github.com/jazzband/django-debug-toolbar/pull/1656
* Remove signed_data_view decorator to support url type checking. by tim-schilling in https://github.com/jazzband/django-debug-toolbar/pull/1658
* Upgrade GitHub Actions by cclauss in https://github.com/jazzband/django-debug-toolbar/pull/1660
* Fix 1662: Avoid assigning arbitrary attributes to SafeString instances by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1663

New Contributors
* jonatron made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1648
* timgates42 made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1652

**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/3.5...3.6

3.5

What's Changed
* Explicit external link, hopefully fixes the docs linting action by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1618
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/jazzband/django-debug-toolbar/pull/1617
* Add the upcoming Django 4.1 to the CI matrix by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1623
* Remove a couple of archived third-party repos by cclauss in https://github.com/jazzband/django-debug-toolbar/pull/1622
* Replace OrderedDict by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1625
* Fix 1621: Do not crash when encountering unexpected data in the request by matthiask in https://github.com/jazzband/django-debug-toolbar/pull/1624
* Cache panel work by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1626
* Get PostgreSQL transaction tracking working by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1619
* Add pyflame to the list of third-party panels by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1628
* Fix cache panel miss counting by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1629
* Stacktrace cleanups by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1630
* Increase minimum coverage percentage to 93% by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1632
* Stack trace rework by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1631
* Minor documentation updates by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1634
* Reimplement HIDE_IN_STACKTRACES machinery by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1635
* Rework similary/duplicate query grouping by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1636
* Simplify SQLPanel._queries data structure by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1638
* Tweak get_stack_trace() API by living180 in https://github.com/jazzband/django-debug-toolbar/pull/1637

New Contributors
* cclauss made their first contribution in https://github.com/jazzband/django-debug-toolbar/pull/1622

And thank you living180 for the plethora of PRs this release.

**Full Changelog**: https://github.com/jazzband/django-debug-toolbar/compare/3.4...3.5
Links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant