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/javscript" 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.2.tar.gz (15.0 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for django-debugtools-1.2.tar.gz
Algorithm Hash digest
SHA256 3195c1e2b6bb05ead3da5d41cfce0074de220d5252d7e36b71135fbd319a123e
MD5 cd79c41939781fd11114024d3d4ead96
BLAKE2b-256 8c7bf208d41aa1fc064e2316c83fa9b6ea0d91afa83b23a4f8f4f2fe080c258b

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