Metadata-Version: 1.0
Name: django-janitor
Version: 0.3.0
Summary: django-janitor allows you to use bleach to clean HTML stored in a Model's field.
Home-page: https://bitbucket.org/bkmontgomery/django-janitor/
Author: Brad Montgomery
Author-email: brad@bradmontgomery.net
License: BSD
Description: ========
        Overview
        ========
        
        django-janitor allows you to use bleach_ to clean HTML stored in a Model's
        field.
        
        Features
        --------
        * You don't need to edit an existing app (django-janitor listens for a Models'
          pre_save signal)
        * Allowed HTML tags, attributes, and css are specified in a whitelist
        * Whitelists are managed in Django's Admin
        * There are (sensible) default whitelists included
        
        Requirements
        ------------
        * Requires Bleach >= 1.2.1
        * Requires Django >= 1.4.5
        
        Installation
        ------------
        To install the most recent release::
        
            pip install django-janitor
        
        To install from the current repository::
        
            pip intall hg+https://bitbucket.org/bkmontgomery/django-janitor/
        
        Then, add ``janitor`` to your installed apps, and run ``syncdb``. Alternatively,
        you can run the migrations if you use south_::
        
            python manage.py migrate janitor
        
        Usage
        -----
        
        Browse to the Janitor app in Django's Admin, and create a new Field sanitizer.
        Then select the Model and specify the fieldname which should be cleaned. After
        you set up the whitelists for Tags, Attributes, etc, save the Field sanitizer.
        
        Then, when you save the Model to which the Field Sanitizer is associated, the
        content in the specified field will be cleaned using bleach_.
        
        Here's a Screenshot:
        
        |screenshot|
        
        Tests
        -----
        
        There are a few tests in ``janitor/tests``. You can run these with::
        
            python manage.py tests janitor
        
        These tests dynamically add a sample app/model to ``INSTALLED_APPS``, then
        call ``syncdb``. Unfortunately, this fails for some versions of pyscopg2
        in Django 1.3 with::
        
            psycopg2.ProgrammingError: autocommit cannot be used inside a transaction
        
        This should work correctly in Django 1.4+, though.
        
        Management Commands
        -------------------
        
        There are a few managment commands avaialable to make it easier to use
        django-janitor. The first is ``clean_all`` which will look at all of the models
        that have a related Field Sanitizer, calling the models' ``save`` method to
        trigger the ``pre_save`` signal (which forces the fields
        to be cleaned)::
        
            python manage.py clean_all
        
        This is useful if you've created a ``FieldSanitizer`` for a model with
        existing content.
        
        The second management command is ``clean_model``, which works in a similar
        fashion, but allows you to specify an app and a model::
        
            python manage.py clean_model myapp.MyModel
        
        Finally, ``list_html_elements`` and ``list_html_elements_for_model`` exist to
        help you discover what HTML elements are being used in existing content. While
        these commands do require that a ``FieldSanitizer`` be configured for existing
        Models, they may be used to help you decide which tags to include in a
        whitelist.
        
        You should run these commands before using ``clean_all`` or ``clean_model`` to
        see what sort of data exists before it's cleaned::
        
            python manage.py list_html_elements
        
        Or::
        
            python manage.py list_html_elements_for_model myapp.MyModel
        
        .. _bleach: https://github.com/jsocol/bleach
        .. |screenshot| image:: https://bitbucket.org/bkmontgomery/django-janitor/raw/d8e9dae3273e/screenshot.png
        .. _south: http://south.aeracode.org
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Markup :: HTML
Classifier: Topic :: Utilities
