Metadata-Version: 1.1
Name: ddt-envelope
Version: 0.1.0
Summary: Simple helper for inspecting non-html views with django-debug-toolbar 
Home-page: https://github.com/swistakm/ddt-envelope
Author: Michał Jaworski
Author-email: swistakm@gmail.com
License: UNKNOWN
Description: |Build Status| |Coverage Status|
        
        ddt-envelope
        ============
        
        Simple solution to use django-debug-toolbar with non HTML views. Helps
        in inspecting/profiling endpoints that do not return HTML responses
        (like JSON endpoint).
        
        It is tested on latest point releases of: ``django1.4``, ``django1.5``,
        ``django1.6``, ``django1.7``, ``django1.8`` and each python version that
        is supported by given django releases accordingly (ie. ``python2.6``,
        ``python2.7``, ``python3.2``, ``python3.3``, ``python3.4``).
        
        Instalation
        ===========
        
        0. Install with pip:
        
           ::
        
               pip install ddt-envelope
        
        1. Add ``ddt-envelope`` to your ``INSTALLED_APPS``:
        
           .. code:: python
        
        
               if DEBUG is True:
                   INSTALLED_APPS += (
                       'ddt_envelope',
                   )
        
        2. Add ``ddt_envelope`` at the end of your ``urls.py``
        
           .. code:: python
        
               from django.conf import settings
        
               if 'ddt_envelope' in settings.INSTALLED_APPS:
                  urlpatterns += patterns('',
                      # note: you can use any prefix other than '__ddte__' but make
                      #       sure it does not conflict with other url patterns
                      url(r'^__ddte__/', include('ddt_envelope.urls')),
                  )
        
        Usage
        =====
        
        Once installed and configured just insert ``__ddte__`` or your custom
        prefix after hostname in browser of choice to inspect non-html views
        like:
        
        ::
        
            http://example.com/__ddte__/maybe/json/
        
        Customizing output
        ==================
        
        You can customize ``ddt_envelope`` responses either by providing custom
        template name for ``ddt_envelope.views.EnvelopeView`` or by overriding
        ``ddte/envelope.html`` template. Context variables passed to this
        templeta are:
        
        -  ``path`` - "real" path of inspected view
        -  ``response`` - response object returned by target inspected view
        -  ``headers`` - dictionary of headers available in response returned by
           target inspected view
        -  ``content`` - string with raw response content (JSON it will be
           reformated using ``json.dumps(..., indent=4)``)
        
        .. |Build Status| image:: https://travis-ci.org/swistakm/ddt-envelope.svg
           :target: https://travis-ci.org/swistakm/ddt-envelope
        .. |Coverage Status| image:: https://coveralls.io/repos/swistakm/ddt-envelope/badge.svg
           :target: https://coveralls.io/r/swistakm/ddt-envelope
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.4
Classifier: Framework :: Django :: 1.5
Classifier: Framework :: Django :: 1.6
Classifier: Framework :: Django :: 1.7
Classifier: Framework :: Django :: 1.8
