Python JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
demo fix squashed exception demo Jul 1, 2017
docs exceptions: allow a way to supress squashed exceptions logging Feb 19, 2018
src/pyramid_debugtoolbar
tests
.gitignore
.travis.yml turn off travis for py27-pyramid15 Jul 1, 2017
CHANGES.txt prep 4.4 Feb 20, 2018
CONTRIBUTORS.txt exceptions: allow a way to supress squashed exceptions logging Feb 19, 2018
LICENSE.txt White space clean up Jun 7, 2017
MANIFEST.in fix manifest Jul 1, 2017
README.rst fix paths Apr 23, 2016
RELEASING.txt update version Apr 23, 2016
TODO.txt Update TODO Sep 17, 2013
contributing.md update pylonsproject.org URLs Jun 16, 2017
rtd.txt allow rtd to build with the doc requirements Apr 25, 2015
setup.cfg
setup.py
tox.ini add linting and a manifest Jul 1, 2017

README.rst

pyramid_debugtoolbar

pyramid_debugtoolbar provides a debug toolbar useful while you're developing your Pyramid application.

Note that pyramid_debugtoolbar is a blatant rip-off of Michael van Tellingen's flask-debugtoolbar (which itself was derived from Rob Hudson's django-debugtoolbar). It also includes a lightly sanded down version of the Werkzeug debugger code by Armin Ronacher and team.

Documentation

The documentation of the current stable release of pyramid_debugtoolbar is available at http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest/.

Demonstration

For a demonstration:

  • Clone the pyramid_debugtoolbar trunk.

    $ git clone https://github.com/Pylons/pyramid_debugtoolbar.git
  • Create a virtual environment in the workspace.

    $ cd pyramid_debugtoolbar
    $ python3 -m venv env
  • Install the pyramid_debugtoolbar trunk into the virtualenv.

    $ env/bin/pip install -e .
  • Install the pyramid_debugtoolbar/demo package into the virtualenv.

    $ env/bin/pip install -e demo
  • Run the pyramid_debugtoolbar package's demo/demo.py file using the virtual environment's Python.

    $ env/bin/python demo/demo.py

Visit http://localhost:8080 in a web browser to see a page full of test options.

Testing

If you have tox installed, run all tests with:

$ tox

To run only a specific Python environment:

$ tox -e py35

If you don't have tox installed, you can install the testing requirements, then run the tests.

$ python3 -m venv env
$ env/bin/pip install -e ".[testing]"
$ env/bin/nosetests

Building documentation

If you have tox installed, build the docs with:

$ tox -e docs

If you don't have tox installed, you can install the requirements to build the docs, then build them.

$ env/bin/pip install -e ".[docs]"
$ cd docs
$ make clean html SPHINXBUILD=../env/bin/sphinx-build