https://github.com/santiagobasulto/debug-inspector-panel

A django-debug-toolbar panel to get information about certain variables.
https://github.com/santiagobasulto/debug-inspector-panel

Last synced: 5 days ago
JSON representation

A django-debug-toolbar panel to get information about certain variables.

• Host: GitHub
• URL: https://github.com/santiagobasulto/debug-inspector-panel
• Owner: santiagobasulto
• License: wtfpl
• Created: 2012-07-15T23:50:02.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2018-08-27T15:05:06.000Z (about 6 years ago)
• Last Synced: 2024-08-04T04:05:35.511Z (3 months ago)
• Language: Python
• Size: 10.7 KB
• Stars: 71
• Watchers: 8
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - debug-inspector-panel - A django-debug-toolbar panel to get information about certain variables. (Python)

README

        
# This project has been abandoned. There's an updated version by @hgezim here: https://github.com/hgezim/debug-inspector-panel

Inspector Panel

===============

> So long as I can put `print` statements in the code, and can read it thoroughly, I can usually find the bugs.

*Joshua Bloch*, about his techniques for debugging programs (extracted from [Coders at work](http://goo.gl/WI0RU))

Inspector panel is intended to retrieve information about variables when developing Django applications.

The panel must be used with [django-debug-toolbar](https://github.com/django-debug-toolbar/django-debug-toolbar).

### Motivation

Have you found yourself doing this all the time?:

    def my_view(request):

        my_var = some_third_party_function()

        print my_var

        print type(my_var)

        #...

Well, I used to do that a lot. So, I decided to write this simple panel.

The idea is to use just one function `debug` and get lots of information. Here's an example of a [real Django App](https://github.com/santiagobasulto/guide-to-testing-in-django):

    from inspector_panel.panels.inspector import debug

    def index(request):

        latest_poll_list = Poll.published.all().order_by('-pub_date')[:5]

        debug(latest_poll_list)  # Just add this line

        return render_to_response('polls/index.html', {'latest_poll_list': latest_poll_list})

You get first some information in the Debug Toolbar:

![Debug Toolbar panel](http://i.imgur.com/Wv9rV.png)

And you can optionally get the same info in the console:

![Console debug](http://i.imgur.com/z4Ybe.png)

### Installation

    $ pip install git+git://github.com/santiagobasulto/debug-inspector-panel

Add the panel to the `DEBUG_TOOLBAR_PANELS` settings variable: 

    DEBUG_TOOLBAR_PANELS = (

        ...

        'inspector_panel.panels.inspector.InspectorPanel',

        ...

    )

Add `inspector_panel` to your `INSTALLED_APPS`

    INSTALLED_APPS = (

        # ... More Apps ... #

        'debug_toolbar',

        'inspector_panel'

    )

### Use

Just import the debug function:

    from inspector_panel import debug

and use it to debug whatever you want:

    debug([1, 2, 3])

    debug(Poll)

    debug(Poll.objects.all())

    def my_function():

        print "Hello World"

    debug(my_function)

Optionally you can disable console logging:

    debug([1, 2, 3], console=False)

### Important!

This panel is NOT a replacement for other more complete tools as [python logging](http://docs.python.org/library/logging.html) and [pdb](http://docs.python.org/library/pdb).

### License

See LICENSE on project root.