mirror of
https://github.com/pallets-eco/flask-debugtoolbar.git
synced 2026-01-06 05:30:12 -06:00
Compare commits
16 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
72e8e277af | ||
|
|
75bac4e961 | ||
|
|
f84087156a | ||
|
|
56be56de86 | ||
|
|
7e8a8e280e | ||
|
|
672fdb59e6 | ||
|
|
b5a6fbe839 | ||
|
|
824f73d9aa | ||
|
|
d8d2fb7a85 | ||
|
|
8a922a2a5c | ||
|
|
ba56f81d19 | ||
|
|
002dea199e | ||
|
|
bb99b48833 | ||
|
|
210dfb48fc | ||
|
|
7e83d45d6c | ||
|
|
6d268ba00b |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -2,3 +2,4 @@
|
|||||||
*.pyc
|
*.pyc
|
||||||
build/
|
build/
|
||||||
dist/
|
dist/
|
||||||
|
docs/_build
|
||||||
|
|||||||
24
CHANGES.rst
24
CHANGES.rst
@@ -1,6 +1,30 @@
|
|||||||
Changes
|
Changes
|
||||||
=======
|
=======
|
||||||
|
|
||||||
|
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)
|
0.6.1 (2012-02-15)
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
|
|||||||
@@ -1,2 +1,2 @@
|
|||||||
recursive-include flask_debugtoolbar/templates/ *.html
|
recursive-include flask_debugtoolbar/templates *.html
|
||||||
recursive-include flask_debugtoolbar/static/ *
|
recursive-include flask_debugtoolbar/static *
|
||||||
|
|||||||
20
README.rst
20
README.rst
@@ -4,10 +4,19 @@ Flask Debug-toolbar
|
|||||||
This is a port of the excellent `django-debug-toolbar <https://github.com/django-debug-toolbar/django-debug-toolbar>`_
|
This is a port of the excellent `django-debug-toolbar <https://github.com/django-debug-toolbar/django-debug-toolbar>`_
|
||||||
for Flask applications.
|
for Flask applications.
|
||||||
|
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
Installing is simple with pip::
|
||||||
|
|
||||||
|
$ pip install flask-debugtoolbar
|
||||||
|
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
-----
|
-----
|
||||||
|
|
||||||
Installing the debug toolbar is simple::
|
Setting up the debug toolbar is simple::
|
||||||
|
|
||||||
from flask import Flask
|
from flask import Flask
|
||||||
from flask_debugtoolbar import DebugToolbarExtension
|
from flask_debugtoolbar import DebugToolbarExtension
|
||||||
@@ -26,11 +35,6 @@ Installing the debug toolbar is simple::
|
|||||||
The toolbar will automatically be injected into Jinja templates when debug mode is on.
|
The toolbar will automatically be injected into Jinja templates when debug mode is on.
|
||||||
In production, setting ``app.debug = False`` will disable the toolbar.
|
In production, setting ``app.debug = False`` will disable the toolbar.
|
||||||
|
|
||||||
|
See the `documentation`_ for more information.
|
||||||
|
|
||||||
Installation
|
.. _documentation: http://flask-debugtoolbar.readthedocs.org
|
||||||
------------
|
|
||||||
|
|
||||||
Installing is simple with pip::
|
|
||||||
|
|
||||||
$ pip install flask-debugtoolbar
|
|
||||||
|
|
||||||
|
|||||||
153
docs/Makefile
Normal file
153
docs/Makefile
Normal file
@@ -0,0 +1,153 @@
|
|||||||
|
# Makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line.
|
||||||
|
SPHINXOPTS =
|
||||||
|
SPHINXBUILD = sphinx-build
|
||||||
|
PAPER =
|
||||||
|
BUILDDIR = _build
|
||||||
|
|
||||||
|
# Internal variables.
|
||||||
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||||
|
PAPEROPT_letter = -D latex_paper_size=letter
|
||||||
|
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||||
|
# the i18n builder cannot share the environment and doctrees with the others
|
||||||
|
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||||
|
|
||||||
|
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
||||||
|
|
||||||
|
help:
|
||||||
|
@echo "Please use \`make <target>' where <target> is one of"
|
||||||
|
@echo " html to make standalone HTML files"
|
||||||
|
@echo " dirhtml to make HTML files named index.html in directories"
|
||||||
|
@echo " singlehtml to make a single large HTML file"
|
||||||
|
@echo " pickle to make pickle files"
|
||||||
|
@echo " json to make JSON files"
|
||||||
|
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||||
|
@echo " qthelp to make HTML files and a qthelp project"
|
||||||
|
@echo " devhelp to make HTML files and a Devhelp project"
|
||||||
|
@echo " epub to make an epub"
|
||||||
|
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||||
|
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||||
|
@echo " text to make text files"
|
||||||
|
@echo " man to make manual pages"
|
||||||
|
@echo " texinfo to make Texinfo files"
|
||||||
|
@echo " info to make Texinfo files and run them through makeinfo"
|
||||||
|
@echo " gettext to make PO message catalogs"
|
||||||
|
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||||
|
@echo " linkcheck to check all external links for integrity"
|
||||||
|
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||||
|
|
||||||
|
clean:
|
||||||
|
-rm -rf $(BUILDDIR)/*
|
||||||
|
|
||||||
|
html:
|
||||||
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||||
|
|
||||||
|
dirhtml:
|
||||||
|
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||||
|
|
||||||
|
singlehtml:
|
||||||
|
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||||
|
|
||||||
|
pickle:
|
||||||
|
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can process the pickle files."
|
||||||
|
|
||||||
|
json:
|
||||||
|
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can process the JSON files."
|
||||||
|
|
||||||
|
htmlhelp:
|
||||||
|
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||||
|
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||||
|
|
||||||
|
qthelp:
|
||||||
|
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||||
|
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||||
|
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Flask-DebugToolbar.qhcp"
|
||||||
|
@echo "To view the help file:"
|
||||||
|
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Flask-DebugToolbar.qhc"
|
||||||
|
|
||||||
|
devhelp:
|
||||||
|
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished."
|
||||||
|
@echo "To view the help file:"
|
||||||
|
@echo "# mkdir -p $$HOME/.local/share/devhelp/Flask-DebugToolbar"
|
||||||
|
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Flask-DebugToolbar"
|
||||||
|
@echo "# devhelp"
|
||||||
|
|
||||||
|
epub:
|
||||||
|
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||||
|
|
||||||
|
latex:
|
||||||
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||||
|
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||||
|
"(use \`make latexpdf' here to do that automatically)."
|
||||||
|
|
||||||
|
latexpdf:
|
||||||
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
|
@echo "Running LaTeX files through pdflatex..."
|
||||||
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||||
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||||
|
|
||||||
|
text:
|
||||||
|
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||||
|
|
||||||
|
man:
|
||||||
|
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||||
|
|
||||||
|
texinfo:
|
||||||
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||||
|
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||||
|
"(use \`make info' here to do that automatically)."
|
||||||
|
|
||||||
|
info:
|
||||||
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||||
|
@echo "Running Texinfo files through makeinfo..."
|
||||||
|
make -C $(BUILDDIR)/texinfo info
|
||||||
|
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||||
|
|
||||||
|
gettext:
|
||||||
|
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||||
|
|
||||||
|
changes:
|
||||||
|
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||||
|
@echo
|
||||||
|
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||||
|
|
||||||
|
linkcheck:
|
||||||
|
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||||
|
@echo
|
||||||
|
@echo "Link check complete; look for any errors in the above output " \
|
||||||
|
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||||
|
|
||||||
|
doctest:
|
||||||
|
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||||
|
@echo "Testing of doctests in the sources finished, look at the " \
|
||||||
|
"results in $(BUILDDIR)/doctest/output.txt."
|
||||||
0
docs/_static/.gitignore
vendored
Normal file
0
docs/_static/.gitignore
vendored
Normal file
0
docs/_templates/.gitignore
vendored
Normal file
0
docs/_templates/.gitignore
vendored
Normal file
242
docs/conf.py
Normal file
242
docs/conf.py
Normal file
@@ -0,0 +1,242 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# Flask-DebugToolbar documentation build configuration file, created by
|
||||||
|
# sphinx-quickstart on Wed Feb 15 18:08:39 2012.
|
||||||
|
#
|
||||||
|
# This file is execfile()d with the current directory set to its containing dir.
|
||||||
|
#
|
||||||
|
# Note that not all possible configuration values are present in this
|
||||||
|
# autogenerated file.
|
||||||
|
#
|
||||||
|
# All configuration values have a default; values that are commented out
|
||||||
|
# serve to show the default.
|
||||||
|
|
||||||
|
import sys, os
|
||||||
|
|
||||||
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
|
#sys.path.insert(0, os.path.abspath('.'))
|
||||||
|
|
||||||
|
# -- General configuration -----------------------------------------------------
|
||||||
|
|
||||||
|
# If your documentation needs a minimal Sphinx version, state it here.
|
||||||
|
#needs_sphinx = '1.0'
|
||||||
|
|
||||||
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||||
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
|
extensions = ['sphinx.ext.viewcode']
|
||||||
|
|
||||||
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
templates_path = ['_templates']
|
||||||
|
|
||||||
|
# The suffix of source filenames.
|
||||||
|
source_suffix = '.rst'
|
||||||
|
|
||||||
|
# The encoding of source files.
|
||||||
|
#source_encoding = 'utf-8-sig'
|
||||||
|
|
||||||
|
# The master toctree document.
|
||||||
|
master_doc = 'index'
|
||||||
|
|
||||||
|
# General information about the project.
|
||||||
|
project = u'Flask-DebugToolbar'
|
||||||
|
copyright = u'2012, Matt Good'
|
||||||
|
|
||||||
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
|
# |version| and |release|, also used in various other places throughout the
|
||||||
|
# built documents.
|
||||||
|
#
|
||||||
|
# The short X.Y version.
|
||||||
|
version = '0.6'
|
||||||
|
# The full version, including alpha/beta/rc tags.
|
||||||
|
release = '0.6.1'
|
||||||
|
|
||||||
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
# for a list of supported languages.
|
||||||
|
#language = None
|
||||||
|
|
||||||
|
# There are two options for replacing |today|: either, you set today to some
|
||||||
|
# non-false value, then it is used:
|
||||||
|
#today = ''
|
||||||
|
# Else, today_fmt is used as the format for a strftime call.
|
||||||
|
#today_fmt = '%B %d, %Y'
|
||||||
|
|
||||||
|
# List of patterns, relative to source directory, that match files and
|
||||||
|
# directories to ignore when looking for source files.
|
||||||
|
exclude_patterns = ['_build']
|
||||||
|
|
||||||
|
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||||
|
#default_role = None
|
||||||
|
|
||||||
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||||
|
#add_function_parentheses = True
|
||||||
|
|
||||||
|
# If true, the current module name will be prepended to all description
|
||||||
|
# unit titles (such as .. function::).
|
||||||
|
#add_module_names = True
|
||||||
|
|
||||||
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||||
|
# output. They are ignored by default.
|
||||||
|
#show_authors = False
|
||||||
|
|
||||||
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
|
pygments_style = 'sphinx'
|
||||||
|
|
||||||
|
# A list of ignored prefixes for module index sorting.
|
||||||
|
#modindex_common_prefix = []
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for HTML output ---------------------------------------------------
|
||||||
|
|
||||||
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
|
# a list of builtin themes.
|
||||||
|
html_theme = 'default'
|
||||||
|
|
||||||
|
# Theme options are theme-specific and customize the look and feel of a theme
|
||||||
|
# further. For a list of options available for each theme, see the
|
||||||
|
# documentation.
|
||||||
|
#html_theme_options = {}
|
||||||
|
|
||||||
|
# Add any paths that contain custom themes here, relative to this directory.
|
||||||
|
#html_theme_path = []
|
||||||
|
|
||||||
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
|
# "<project> v<release> documentation".
|
||||||
|
#html_title = None
|
||||||
|
|
||||||
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||||
|
#html_short_title = None
|
||||||
|
|
||||||
|
# The name of an image file (relative to this directory) to place at the top
|
||||||
|
# of the sidebar.
|
||||||
|
#html_logo = None
|
||||||
|
|
||||||
|
# The name of an image file (within the static path) to use as favicon of the
|
||||||
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||||
|
# pixels large.
|
||||||
|
#html_favicon = None
|
||||||
|
|
||||||
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
|
html_static_path = ['_static']
|
||||||
|
|
||||||
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||||
|
# using the given strftime format.
|
||||||
|
#html_last_updated_fmt = '%b %d, %Y'
|
||||||
|
|
||||||
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||||
|
# typographically correct entities.
|
||||||
|
#html_use_smartypants = True
|
||||||
|
|
||||||
|
# Custom sidebar templates, maps document names to template names.
|
||||||
|
#html_sidebars = {}
|
||||||
|
|
||||||
|
# Additional templates that should be rendered to pages, maps page names to
|
||||||
|
# template names.
|
||||||
|
#html_additional_pages = {}
|
||||||
|
|
||||||
|
# If false, no module index is generated.
|
||||||
|
#html_domain_indices = True
|
||||||
|
|
||||||
|
# If false, no index is generated.
|
||||||
|
#html_use_index = True
|
||||||
|
|
||||||
|
# If true, the index is split into individual pages for each letter.
|
||||||
|
#html_split_index = False
|
||||||
|
|
||||||
|
# If true, links to the reST sources are added to the pages.
|
||||||
|
#html_show_sourcelink = True
|
||||||
|
|
||||||
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||||
|
#html_show_sphinx = True
|
||||||
|
|
||||||
|
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||||
|
#html_show_copyright = True
|
||||||
|
|
||||||
|
# If true, an OpenSearch description file will be output, and all pages will
|
||||||
|
# contain a <link> tag referring to it. The value of this option must be the
|
||||||
|
# base URL from which the finished HTML is served.
|
||||||
|
#html_use_opensearch = ''
|
||||||
|
|
||||||
|
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||||
|
#html_file_suffix = None
|
||||||
|
|
||||||
|
# Output file base name for HTML help builder.
|
||||||
|
htmlhelp_basename = 'Flask-DebugToolbardoc'
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for LaTeX output --------------------------------------------------
|
||||||
|
|
||||||
|
latex_elements = {
|
||||||
|
# The paper size ('letterpaper' or 'a4paper').
|
||||||
|
#'papersize': 'letterpaper',
|
||||||
|
|
||||||
|
# The font size ('10pt', '11pt' or '12pt').
|
||||||
|
#'pointsize': '10pt',
|
||||||
|
|
||||||
|
# Additional stuff for the LaTeX preamble.
|
||||||
|
#'preamble': '',
|
||||||
|
}
|
||||||
|
|
||||||
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
|
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||||
|
latex_documents = [
|
||||||
|
('index', 'Flask-DebugToolbar.tex', u'Flask-DebugToolbar Documentation',
|
||||||
|
u'Matt Good', 'manual'),
|
||||||
|
]
|
||||||
|
|
||||||
|
# The name of an image file (relative to this directory) to place at the top of
|
||||||
|
# the title page.
|
||||||
|
#latex_logo = None
|
||||||
|
|
||||||
|
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||||
|
# not chapters.
|
||||||
|
#latex_use_parts = False
|
||||||
|
|
||||||
|
# If true, show page references after internal links.
|
||||||
|
#latex_show_pagerefs = False
|
||||||
|
|
||||||
|
# If true, show URL addresses after external links.
|
||||||
|
#latex_show_urls = False
|
||||||
|
|
||||||
|
# Documents to append as an appendix to all manuals.
|
||||||
|
#latex_appendices = []
|
||||||
|
|
||||||
|
# If false, no module index is generated.
|
||||||
|
#latex_domain_indices = True
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for manual page output --------------------------------------------
|
||||||
|
|
||||||
|
# One entry per manual page. List of tuples
|
||||||
|
# (source start file, name, description, authors, manual section).
|
||||||
|
man_pages = [
|
||||||
|
('index', 'flask-debugtoolbar', u'Flask-DebugToolbar Documentation',
|
||||||
|
[u'Matt Good'], 1)
|
||||||
|
]
|
||||||
|
|
||||||
|
# If true, show URL addresses after external links.
|
||||||
|
#man_show_urls = False
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for Texinfo output ------------------------------------------------
|
||||||
|
|
||||||
|
# Grouping the document tree into Texinfo files. List of tuples
|
||||||
|
# (source start file, target name, title, author,
|
||||||
|
# dir menu entry, description, category)
|
||||||
|
texinfo_documents = [
|
||||||
|
('index', 'Flask-DebugToolbar', u'Flask-DebugToolbar Documentation',
|
||||||
|
u'Matt Good', 'Flask-DebugToolbar', 'One line description of project.',
|
||||||
|
'Miscellaneous'),
|
||||||
|
]
|
||||||
|
|
||||||
|
# Documents to append as an appendix to all manuals.
|
||||||
|
#texinfo_appendices = []
|
||||||
|
|
||||||
|
# If false, no module index is generated.
|
||||||
|
#texinfo_domain_indices = True
|
||||||
|
|
||||||
|
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||||
|
#texinfo_show_urls = 'footnote'
|
||||||
74
docs/index.rst
Normal file
74
docs/index.rst
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
.. Flask-DebugToolbar documentation master file, created by
|
||||||
|
sphinx-quickstart on Wed Feb 15 18:08:39 2012.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
Welcome to Flask-DebugToolbar's documentation!
|
||||||
|
==============================================
|
||||||
|
|
||||||
|
This is a port of the excellent `django-debug-toolbar <https://github.com/django-debug-toolbar/django-debug-toolbar>`_
|
||||||
|
for Flask applications.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
Configuration
|
||||||
|
-------------
|
||||||
|
|
||||||
|
The toolbar support several configuration options:
|
||||||
|
|
||||||
|
================================ ===================================== ==========================
|
||||||
|
Name Description Default
|
||||||
|
================================ ===================================== ==========================
|
||||||
|
``DEBUG_TB_ENABLED`` Enable the toolbar? ``app.debug``
|
||||||
|
``DEBUG_TB_HOSTS`` Whitelist of hosts to display toolbar any host
|
||||||
|
``DEBUG_TB_INTERCEPT_REDIRECTS`` Should intercept redirects? ``True``
|
||||||
|
``DEBUG_TB_PANELS`` List of module/class names of panels enable all built-in panels
|
||||||
|
================================ ===================================== ==========================
|
||||||
|
|
||||||
|
To change one of the config options, set it in the Flask app's config like::
|
||||||
|
|
||||||
|
app.config['DEBUG_TB_INTERCEPT_REDIRECTS'] = False
|
||||||
|
|
||||||
|
|
||||||
|
Contributing
|
||||||
|
------------
|
||||||
|
|
||||||
|
Fork us `on GitHub <https://github.com/mgood/flask-debugtoolbar>`_
|
||||||
|
|
||||||
|
|
||||||
|
Indices and tables
|
||||||
|
==================
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`modindex`
|
||||||
|
* :ref:`search`
|
||||||
|
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
import hashlib
|
import hashlib
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from flaskext.sqlalchemy import get_debug_queries, SQLAlchemy
|
from flask.ext.sqlalchemy import get_debug_queries, SQLAlchemy
|
||||||
except ImportError:
|
except ImportError:
|
||||||
sqlalchemy_available = False
|
sqlalchemy_available = False
|
||||||
get_debug_queries = SQLAlchemy = None
|
get_debug_queries = SQLAlchemy = None
|
||||||
|
|||||||
@@ -1,19 +1,4 @@
|
|||||||
(function(window, document, version, callback) {
|
(function($) {
|
||||||
var j, d;
|
|
||||||
var loaded = false;
|
|
||||||
if (!(j = window.jQuery) || version > j.fn.jquery || callback(j)) {
|
|
||||||
var script = document.createElement("script");
|
|
||||||
script.type = "text/javascript";
|
|
||||||
script.src = DEBUG_TOOLBAR_STATIC_PATH + "js/jquery.js";
|
|
||||||
script.onload = script.onreadystatechange = function() {
|
|
||||||
if (!loaded && (!(d = this.readyState) || d == "loaded" || d == "complete")) {
|
|
||||||
callback((j = window.jQuery).noConflict(1), loaded = true);
|
|
||||||
j(script).remove();
|
|
||||||
}
|
|
||||||
};
|
|
||||||
document.documentElement.childNodes[0].appendChild(script)
|
|
||||||
}
|
|
||||||
})(window, document, "1.3", function($, jquery_loaded) {
|
|
||||||
$.cookie = function(name, value, options) { if (typeof value != 'undefined') { options = options || {}; if (value === null) { value = ''; options.expires = -1; } var expires = ''; if (options.expires && (typeof options.expires == 'number' || options.expires.toUTCString)) { var date; if (typeof options.expires == 'number') { date = new Date(); date.setTime(date.getTime() + (options.expires * 24 * 60 * 60 * 1000)); } else { date = options.expires; } expires = '; expires=' + date.toUTCString(); } var path = options.path ? '; path=' + (options.path) : ''; var domain = options.domain ? '; domain=' + (options.domain) : ''; var secure = options.secure ? '; secure' : ''; document.cookie = [name, '=', encodeURIComponent(value), expires, path, domain, secure].join(''); } else { var cookieValue = null; if (document.cookie && document.cookie != '') { var cookies = document.cookie.split(';'); for (var i = 0; i < cookies.length; i++) { var cookie = $.trim(cookies[i]); if (cookie.substring(0, name.length + 1) == (name + '=')) { cookieValue = decodeURIComponent(cookie.substring(name.length + 1)); break; } } } return cookieValue; } };
|
$.cookie = function(name, value, options) { if (typeof value != 'undefined') { options = options || {}; if (value === null) { value = ''; options.expires = -1; } var expires = ''; if (options.expires && (typeof options.expires == 'number' || options.expires.toUTCString)) { var date; if (typeof options.expires == 'number') { date = new Date(); date.setTime(date.getTime() + (options.expires * 24 * 60 * 60 * 1000)); } else { date = options.expires; } expires = '; expires=' + date.toUTCString(); } var path = options.path ? '; path=' + (options.path) : ''; var domain = options.domain ? '; domain=' + (options.domain) : ''; var secure = options.secure ? '; secure' : ''; document.cookie = [name, '=', encodeURIComponent(value), expires, path, domain, secure].join(''); } else { var cookieValue = null; if (document.cookie && document.cookie != '') { var cookies = document.cookie.split(';'); for (var i = 0; i < cookies.length; i++) { var cookie = $.trim(cookies[i]); if (cookie.substring(0, name.length + 1) == (name + '=')) { cookieValue = decodeURIComponent(cookie.substring(name.length + 1)); break; } } } return cookieValue; } };
|
||||||
$('head').append('<link rel="stylesheet" href="'+DEBUG_TOOLBAR_STATIC_PATH+'css/toolbar.css?'+ Math.random() +'" type="text/css" />');
|
$('head').append('<link rel="stylesheet" href="'+DEBUG_TOOLBAR_STATIC_PATH+'css/toolbar.css?'+ Math.random() +'" type="text/css" />');
|
||||||
var COOKIE_NAME = 'fldt';
|
var COOKIE_NAME = 'fldt';
|
||||||
@@ -181,4 +166,4 @@
|
|||||||
fldt.init();
|
fldt.init();
|
||||||
});
|
});
|
||||||
|
|
||||||
});
|
})(jQuery.noConflict(true));
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
<div id="flDebug" style="display:none;">
|
<div id="flDebug" style="display:none;">
|
||||||
<script type="text/javascript">var DEBUG_TOOLBAR_STATIC_PATH = '{{ static_path }}'</script>
|
<script type="text/javascript">var DEBUG_TOOLBAR_STATIC_PATH = '{{ static_path }}'</script>
|
||||||
|
<script type="text/javascript" src="{{ static_path }}js/jquery.js"></script>
|
||||||
<script type="text/javascript" src="{{ static_path }}js/toolbar.js"></script>
|
<script type="text/javascript" src="{{ static_path }}js/toolbar.js"></script>
|
||||||
|
|
||||||
<div style="display: none;" id="flDebugToolbar">
|
<div style="display: none;" id="flDebugToolbar">
|
||||||
|
|||||||
@@ -7,7 +7,7 @@
|
|||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
{% for key, value in headers.iteritems() %}
|
{% for key, value in headers.iteritems() %}
|
||||||
<tr class="{{ loop.cycle('djDebugOdd' 'djDebugEven') }}">
|
<tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
|
||||||
<td>{{ key|escape }}</td>
|
<td>{{ key|escape }}</td>
|
||||||
<td>{{ value|escape }}</td>
|
<td>{{ value|escape }}</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|||||||
@@ -10,7 +10,7 @@
|
|||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
{% for record in records %}
|
{% for record in records %}
|
||||||
<tr class="{{ loop.cycle('fjDebugOdd' 'fjDebugEven') }}">
|
<tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
|
||||||
<td>{{ record.level }}</td>
|
<td>{{ record.level }}</td>
|
||||||
<td>{{ record.time }}</td>
|
<td>{{ record.time }}</td>
|
||||||
<td>{{ record.message }}</td>
|
<td>{{ record.message }}</td>
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
{% for row in function_calls %}
|
{% for row in function_calls %}
|
||||||
<tr class="{{ loop.cycle('flDebugOdd' 'flDebugEven') }}">
|
<tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
|
||||||
<td>{{ row.ncalls }}</td>
|
<td>{{ row.ncalls }}</td>
|
||||||
<td>{{ row.tottime }}</td>
|
<td>{{ row.tottime }}</td>
|
||||||
<td>{{ '%.4f'|format(row.percall) }}</td>
|
<td>{{ '%.4f'|format(row.percall) }}</td>
|
||||||
|
|||||||
@@ -39,7 +39,7 @@
|
|||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
{% for key, value in map %}
|
{% for key, value in map %}
|
||||||
<tr class="{{ loop.cycle('flDebugOdd' 'flDebugEven') }}">
|
<tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
|
||||||
<td>{{ key|printable }}</td>
|
<td>{{ key|printable }}</td>
|
||||||
<td>{{ value|printable }}</td>
|
<td>{{ value|printable }}</td>
|
||||||
</tr>
|
</tr>
|
||||||
@@ -74,7 +74,7 @@
|
|||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
{% for key, value in map %}
|
{% for key, value in map %}
|
||||||
<tr class="{{ loop.cycle('flDebugOdd' 'flDebugEven') }}">
|
<tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
|
||||||
<td>{{ key|printable }}</td>
|
<td>{{ key|printable }}</td>
|
||||||
<td>
|
<td>
|
||||||
{%- set sep = joiner() -%}
|
{%- set sep = joiner() -%}
|
||||||
|
|||||||
@@ -9,7 +9,7 @@
|
|||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
{% for query in queries %}
|
{% for query in queries %}
|
||||||
<tr class="{{ loop.cycle('flDebugOdd' 'flDebugEven') }}">
|
<tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
|
||||||
<td>{{ '%.4f'|format(query.duration) }}</td>
|
<td>{{ '%.4f'|format(query.duration) }}</td>
|
||||||
<td>
|
<td>
|
||||||
{% if query.params %}
|
{% if query.params %}
|
||||||
@@ -26,7 +26,7 @@
|
|||||||
{{ query.context }}
|
{{ query.context }}
|
||||||
</td>
|
</td>
|
||||||
<td class="syntax">
|
<td class="syntax">
|
||||||
<div class="djDebugSqlWrap">
|
<div class="flDebugSqlWrap">
|
||||||
<div class="flDebugSql">{{ query.sql|safe }}</div>
|
<div class="flDebugSql">{{ query.sql|safe }}</div>
|
||||||
{#
|
{#
|
||||||
{% if query.stacktrace %}
|
{% if query.stacktrace %}
|
||||||
|
|||||||
@@ -10,7 +10,7 @@
|
|||||||
<dt>Time</dt>
|
<dt>Time</dt>
|
||||||
<dd>{{ '%.4f'|format(duration) }} ms</dd>
|
<dd>{{ '%.4f'|format(duration) }} ms</dd>
|
||||||
</dl>
|
</dl>
|
||||||
<table class="djSqlExplain">
|
<table class="flSqlExplain">
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
{% for h in headers %}
|
{% for h in headers %}
|
||||||
@@ -20,7 +20,7 @@
|
|||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
{% for row in result %}
|
{% for row in result %}
|
||||||
<tr class="{{ loop.cycle('fjDebugOdd' 'fjDebugEven') }}">
|
<tr class="{{ loop.cycle('fjDebugOdd', 'fjDebugEven') }}">
|
||||||
{% for column in row %}
|
{% for column in row %}
|
||||||
<td>{{ column }}</td>
|
<td>{{ column }}</td>
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
|||||||
@@ -21,7 +21,7 @@
|
|||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
{% for row in result %}
|
{% for row in result %}
|
||||||
<tr class="{{ loop.cycle('fjDebugOdd' 'fjDebugEven') }}">
|
<tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
|
||||||
{% for column in row %}
|
{% for column in row %}
|
||||||
<td>{{ column }}</td>
|
<td>{{ column }}</td>
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
|||||||
@@ -1,22 +1,23 @@
|
|||||||
{% if templates %}
|
{% if templates %}
|
||||||
<table>
|
{% for template in templates %}
|
||||||
<thead>
|
<h4>{{ template.template.name }}</h4>
|
||||||
<tr>
|
<table>
|
||||||
<th>Filename</th>
|
<thead>
|
||||||
<th>Context vars</th>
|
<tr>
|
||||||
</tr>
|
<th>Variable</th>
|
||||||
</thead>
|
<th>Value</th>
|
||||||
<tbody>
|
</tr>
|
||||||
{% for template in templates %}
|
</thead>
|
||||||
<tr class="{{ loop.cycle('fjDebugOdd' 'fjDebugEven') }}">
|
<tbody>
|
||||||
<td>{{ template.template.name }}</td>
|
{% for k, v in template.context|dictsort %}
|
||||||
<td>{{ template.context.keys()|join(', ') }}</td>
|
<tr class="{{ loop.cycle('flDebugOdd', 'flDebugEven') }}">
|
||||||
</tr>
|
<td>{{ k }}</td>
|
||||||
{% endfor %}
|
<td>{{ v|printable }}</td>
|
||||||
</tbody>
|
</tr>
|
||||||
</table>
|
{% endfor %}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
{% endfor %}
|
||||||
{% else %}
|
{% else %}
|
||||||
<p>No templates rendered.</p>
|
<p>No template rendered</p>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
import urllib
|
||||||
|
|
||||||
from flask import url_for, current_app
|
from flask import url_for, current_app
|
||||||
|
|
||||||
|
|
||||||
@@ -52,7 +54,8 @@ class DebugToolbar(object):
|
|||||||
"""
|
"""
|
||||||
Populate debug panels
|
Populate debug panels
|
||||||
"""
|
"""
|
||||||
activated = self.request.cookies.get('fldt_active', '').split(';')
|
activated = self.request.cookies.get('fldt_active', '')
|
||||||
|
activated = urllib.unquote(activated).split(';')
|
||||||
|
|
||||||
for panel_class in self.panel_classes:
|
for panel_class in self.panel_classes:
|
||||||
panel_instance = panel_class(
|
panel_instance = panel_class(
|
||||||
|
|||||||
2
setup.py
2
setup.py
@@ -14,7 +14,7 @@ except:
|
|||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='Flask-DebugToolbar',
|
name='Flask-DebugToolbar',
|
||||||
version='0.6.1',
|
version='0.6.3.1',
|
||||||
url='http://github.com/mgood/flask-debugtoolbar',
|
url='http://github.com/mgood/flask-debugtoolbar',
|
||||||
license='BSD',
|
license='BSD',
|
||||||
author='Michael van Tellingen',
|
author='Michael van Tellingen',
|
||||||
|
|||||||
Reference in New Issue
Block a user