Skip to main content

A toolbox of small utilities to assist Django development

Project description

Introduction

The debugtools module offers some easy to use debugging utilities to assist Django development. It features:

  • A template tag to print context.

  • A XViewMiddleware variation to see which view and template was used to render a page.

  • A jQuery debug() function.

Installation

First install the module, preferably in a virtual environment. It can be installed from PyPI:

pip install django-debugtools

Or the current folder can be installed:

pip install .

Configuration

Add the module to the installed apps:

INSTALLED_APPS += (
    'debugtools',
)

Features

X-View Middleware

Add the following setting:

INTERNAL_IPS = (
    '127.0.0.1',
)

MIDDLEWARE_CLASSES += (
    'debugtools.middleware.XViewMiddleware',
)

All requests from the internal IP, or made by the admin user will have a X-View header and X-View-Template header. In the Firebug console, or Chrome web inspector, you can see which view and template handled the current request:

https://github.com/edoburu/django-debugtools/raw/master/docs/images/firebug-xview.png

The alternative templates are also displayed, in case the view allows the template to be overwritten with a different name.

jQuery debug print

Add the following to the page:

<script type="text/javascript" src="{{ STATIC_URL }}debugtools/jquery.debug.js"></script>

Now you can print the jQuery selector context to the console:

$("#foo").children('li').debug().addClass('bar');

This will print the matched <li> elements in the console, among with the current jQuery selector. Optionally, a prefix can be included in the debug() call:

$("#foo").debug("at baz: ").addClass('bar');

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-debugtools-1.3.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

django_debugtools-1.3-py2.py3-none-any.whl (15.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-debugtools-1.3.tar.gz.

File metadata

File hashes

Hashes for django-debugtools-1.3.tar.gz
Algorithm Hash digest
SHA256 ee102e4ae51b7d26e134c123469a2f11c75933ff0ae333e4abdba71abad1749e
MD5 47b4a51442f11eda94f234d6a021f902
BLAKE2b-256 a7a28af7c1d6fcd89bccdef185edd703de5061c5084dd1fe102fb8d708d3748e

See more details on using hashes here.

File details

Details for the file django_debugtools-1.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_debugtools-1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e275402dae1c89f821b8fa0d5229259cab9d14b01839e72193030384564f7b3c
MD5 fef3e3cadcf046909879e8b2764e108d
BLAKE2b-256 bf82ec12dff94f3b9e35097d6120e5f8e3c51e9b2d93d96a19ff71c1ea4958e5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page