mirror of
https://github.com/pallets-eco/flask-debugtoolbar.git
synced 2026-05-04 15:29:12 -05:00
Jeff Widman
d713732807
* Switch to python 3.8 in Travis. I tried to add 3.8 while keeping 3.7 and 3.6, but ran into issues with Travis config, so instead just bumped straight to 3.8. Long term I'd like to explore moving to Azure Pipelines, but don't have the time to figure that out just yet. * `flake8` was renamed to `pycodestyle` * `py.test` was deprecated in favor of `pytest`
Flask Debug-toolbar
===================
This is a port of the excellent `django-debug-toolbar <https://github.com/django-debug-toolbar/django-debug-toolbar>`_
for Flask applications.
.. image:: https://travis-ci.org/mgood/flask-debugtoolbar.png?branch=master
:target: https://travis-ci.org/mgood/flask-debugtoolbar
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.
.. _documentation: https://flask-debugtoolbar.readthedocs.io/