mirror of
https://github.com/pallets-eco/flask-debugtoolbar.git
synced 2026-05-04 23:39:13 -05:00
Jeff Widman
b92391d177
Drop `flask_script` in favor of Flask's native CLI: * https://flask.palletsprojects.com/en/master/cli/ This also requires changing the tests so that `pytest` mocks the env var `FLASK_ENV` so that the test app starts in development mode. Unlike normal test apps, we _do_ want development/debug mode, in addition to testing mode.
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/