Flask Debug-toolbar

This is a port of the excellent django-debug-toolbar for Flask applications.

https://travis-ci.org/mgood/flask-debugtoolbar.png?branch=master

Installation

Installing is simple with pip:

$ pip install flask-debugtoolbar

Usage

Setting up the debug toolbar is simple:

from flask import Flask
from flask_debugtoolbar import DebugToolbarExtension

app = Flask(__name__)

# the toolbar is only enabled in debug mode:
app.debug = True

# set a 'SECRET_KEY' to enable the Flask session cookies
app.config['SECRET_KEY'] = '<replace with a secret key>'

toolbar = DebugToolbarExtension(app)

The toolbar will automatically be injected into Jinja templates when debug mode is on. In production, setting app.debug = False will disable the toolbar.

See the documentation for more information.

Changes

0.11.0 (2020-02-18)

Enhancements:

  • Switch to Flask’s native CLI, dropping flask_script in the process (b92391d, thanks @jeffwidman)

  • Do not show DebugToolbar routes in the route map (#86, thanks @floqqi)

  • Document Pygments for SQL highlighting (#127, thanks @pgiraud)

Fixes:

  • Remove deprecated flask.json_available (#119, thanks @davidism)

  • Remove deprecated request.is_xhr (7ce099c, thanks @jeffwidman)

  • Explicitly disable SQLALCHEMY_TRACK_MODIFICATIONS (9c7db48, thanks @jeffwidman)

  • Fix typo (#142, thanks @timgates42)

0.10.1 (2017-02-12)

Enhancements: - Add support for Python wheels

Fixes:

  • Switch imports from deprecated flask.ext.* to flask_* syntax (#94, thanks Michael Lenzen & #97 thanks Iuri de Silvio)

0.10.0 (2015-04-17)

Enhancements:

  • Added new “Routes” panel displaying URL routing rules (#69, thanks Justin McKay)

  • “Versions” panel displays versions of all installed packages (#49, thanks Lucas Taylor)

  • SQLAlchemy displays necessary setup steps to set up query recording

  • Support reformatting SQL queries if sqlparse library is available (#48, thanks Hyunjun Kim)

  • Enable sorting SQLAlchemy queries (#81, thanks Eric Workman)

  • Support inserting toolbar on HTML5 pages without </body> tag

  • Log a warning if unable to insert the toolbar (#20, thanks Rune Halvorsen)

Fixes:

  • Ensure numeric sorting of profiler “Calls” column

0.9.2 (2014-12-05)

Fixes:

  • HTML escape SQL queries when syntax highlighting is not available

  • Use case-insensitive comparison to normalize filenames on Windows

  • Fix exception when SQL query contained non-ASCII characters

0.9.1 (2014-11-24)

Fixes:

  • Fix SQL queries with byte strings on Python 3

  • Fix displaying values whose repr() contains unprintable characters

0.9.0 (2014-01-03)

Enhancements:

  • Python 3 compatibility (#54, thanks justinmayer and jmagnusson)

  • Support .init_app() (#38)

  • New “Config” panel displaying Flask config values (#51, thanks Alexey Diyan)

  • Better PEP8-style formatting (#63, thanks Ivan Ivaschenko)

Fixes:

  • Fix template editor with non-ASCII templates (#46)

0.8 (2013-02-21)

Enhancements:

  • Use itsdangerous to sign SQL queries

  • Expose the jQuery object as fldt.$ so extensions can use the toolbar’s copy of jQuery (#42)

Fixes:

  • Don’t intercept redirects on XHR requests (#41)

  • Fix SQL query time display as milliseconds (#36)

  • Fix functools.partial error (#35)

  • Fix werkzeug request logging with logging panel (#33)

  • Fix SQL panel unicode encoding error (#31)

0.7.1 (2012-05-18)

Fixes:

  • loading template editor in-place over current page

0.7 (2012-05-18)

Enhancements:

  • Add an in-browser template editor to the template panel

  • DEBUG_TB_PROFILER_ENABLED config option to enable the profiler on all requests (normally it is user-enabled by clicking the checkmark)

0.6.3.1 (2012-04-16)

New release to add missing changelog for 0.6.3

0.6.3 (2012-04-16)

Fixes:

  • Compatibility with Flask-SQLAlchemy 0.16 package name

0.6.2 (2012-02-18)

Fixes:

  • Installation issue on Windows with trailing slashes in MANIFEST.in

  • JavaScript error when using conditional comments for <html> tag (like in HTML5 Boilerplate)

0.6.1 (2012-02-15)

Fixes:

  • Memory leak when toolbar was enabled

  • UnicodeDecodeError when request data contained binary data (e.g. session values)

Enhancements:

  • DEBUG_TB_ENABLED config setting to explicitly enable or disable the toolbar

  • DEBUG_TB_HOSTS config setting to enable toolbar only for specific remote hosts

  • New logo for Flask instead of Django

  • Monospaced font on table data

Thanks to kennethreitz and joeshaw for their contributions.

0.6 (2012-01-04)

Flask 0.8 or higher is required

Enhancements:

  • Flask 0.8 compatibility

Thanks to mvantellingen

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.16.0)

Owner

PyPI data
Data sourced directly from PyPI's database.

Credits

Author: Michael van Tellingen

Maintainer: Matt Good

License

BSD License (BSD)

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-DebugToolbar-0.11.0.tar.gz (254.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

Flask_DebugToolbar-0.11.0-py2.py3-none-any.whl (325.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file Flask-DebugToolbar-0.11.0.tar.gz.

File metadata

  • Download URL: Flask-DebugToolbar-0.11.0.tar.gz
  • Upload date:
  • Size: 254.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for Flask-DebugToolbar-0.11.0.tar.gz
Algorithm Hash digest
SHA256 3c4e79d354ede014e6657c545a536d4fb273cc89e3fd6b4835b02e346dd3aab4
MD5 0739b7ae2a8853643b29af4daa1a6c4b
BLAKE2b-256 ec2bd84b57b653401de99bdbddce3ad58dd149b57144c8847c773c93230dd6fa

See more details on using hashes here.

File details

Details for the file Flask_DebugToolbar-0.11.0-py2.py3-none-any.whl.

File metadata

  • Download URL: Flask_DebugToolbar-0.11.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 325.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for Flask_DebugToolbar-0.11.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0e9a80d4c599233c68376e81cc99976200b5ac5248cfb24f18935cc5b69ac5b3
MD5 e3381722c2b097ccfbbbaf5ac3c796ce
BLAKE2b-256 0e60c3e8de2191ecf78d750d1038ab45195b97a9ee569351865d60d01941bcc6

See more details on using hashes here.

Release history Release notifications | RSS feed

0.16.0

2 files

0.15.1

2 files

0.15.0

2 files

0.14.1

2 files

Yanked

0.14.0

2 files

Yanked reason: Fails due to missing `packaging` import, use 0.14.1 instead.

0.13.1

2 files

Yanked

0.13

3 files

Yanked reason: It should have been 0.13.0

Yanked

0.12.1

2 files

Yanked reason: `setup.cfg` has a problem, we'll push a fix later this week.

Yanked

0.12.0

2 files

Yanked reason: `setup.cfg` has a problem, we'll push a fix later this week.

This release

0.11.0 This release

2 files

0.10.1

2 files

0.10.0

1 file

0.9.2

1 file

0.9.1

1 file

0.9.0

1 file

0.8.0

1 file

0.7.1

1 file

0.7

1 file

0.6.3.1

1 file

0.6.3

1 file

0.6.2

1 file

0.6.1

1 file

0.6

1 file

0.5

1 file

0.4.6

1 file

0.4.5

1 file

0.4.4

1 file

0.4.3

1 file

0.4.1

1 file

0.4

1 file

0.03

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page