<commit_before>django-vacuum - Sucks the lint from your Django templates
--------------------------------------------------------

It's pretty minimal right now, so don't get too excited.
<commit_msg>update README to be actually useful<commit_after>django-vacuum - Sucks the lint from your Django templates
--------------------------------------------------------

``django-vacuum`` checks your Django templates for nasties.


Installation:
=============

1. Get the latest source from github (there's no releases yet, sorry)::

    git clone git://github.com/craigds/django-vacuum.git

2. Run setup.py::

    cd django-vacuum
    python setup.py build
    sudo python setup.py install

3. Add 'vacuum' to your INSTALLED_APPS in your django settings file::

    INSTALLED_APPS = (
        # ...,
        'vacuum',
    )


Checking your templates:
========================

Just run::

    django-admin.py checktemplates

Reporting Bugs:
===============

I've only tested this on Django 1.2 with Python 2.6. You *will* find bugs.
When you do, please report them on Github at https://github.com/craigds/django-vacuum/issues

Ideas for new rules (things to check for) are welcome there also.

{'fraction_non_alphanumeric': 0.20857863751051303, 'fraction_numerical': 0.005887300252312868, 'mean_word_length': 2.4195402298850577, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2514032', 'n_tokens_mistral': 352, 'n_tokens_neox': 316, 'n_words': 124}