Metadata-Version: 2.1
Name: Flask-DebugToolbar
Version: 0.13.1
Summary: A toolbar overlay for debugging Flask applications.
Home-page: https://github.com/flask-debugtoolbar/flask-debugtoolbar
Author: Michael van Tellingen
Author-email: michaelvantellingen@gmail.com
Maintainer: Matt Good
Maintainer-email: matt@matt-good.net
License: UNKNOWN
Project-URL: Changelog, https://github.com/flask-debugtoolbar/flask-debugtoolbar/blob/master/CHANGES.rst
Project-URL: Documentation, https://flask-debugtoolbar.readthedocs.io/
Keywords: flask,debug,toolbar
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Flask
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=2.7
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: Flask (>=0.8)
Requires-Dist: Blinker
Requires-Dist: itsdangerous
Requires-Dist: werkzeug

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/flask-debugtoolbar/flask-debugtoolbar.png?branch=master
   :target: https://travis-ci.org/flask-debugtoolbar/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/