<commit_before>Installation
============
From the source repository:

    $ pip install  pip install git+git://github.com/exogen/nose-achievements.git

See INSTALL for more options.

Usage
=====
nose
----
Run like so:

    $ nosetests --with-achievements

Or enable it in `setup.cfg`:

    [nosetests]
    with-achievements=1

unittest
--------
Use the included test runner:

    from noseachievements.runner import AchievementsTestRunner
    
    unittest.main(testRunner=AchievementsTestRunner)

Django 1.2+
-----------
Define `TEST_RUNNER` in `settings.py`:

    TEST_RUNNER = 'noseachievements.djangotest.AchievementsDjangoTestSuiteRunner'

Achievements
============
See the list of achievements on [the homepage][home].

[home]: http://exogen.github.com/nose-achievements/
<commit_msg>Adjusted README formatting, linked INSTALL.<commit_after>Installation
------------
From the source repository:

    $ pip install  pip install git+git://github.com/exogen/nose-achievements.git

See [INSTALL][] for more options.

Usage
-----
### nose
Run like so:

    $ nosetests --with-achievements

Or enable it in `setup.cfg`:

    [nosetests]
    with-achievements=1

### unittest
Use the included test runner:

    from noseachievements.runner import AchievementsTestRunner
    
    unittest.main(testRunner=AchievementsTestRunner)

### Django 1.2+
Define `TEST_RUNNER` in `settings.py`:

    TEST_RUNNER = 'noseachievements.djangotest.AchievementsDjangoTestSuiteRunner'

Achievements
------------
See the list of achievements on [the homepage][home].

[INSTALL]: http://github.com/exogen/nose-achievements/blob/master/INSTALL
[home]: http://exogen.github.com/nose-achievements/
{'fraction_non_alphanumeric': 0.14046622833233713, 'fraction_numerical': 0.0035863717872086074, 'mean_word_length': 3.782857142857143, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, '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': '2829378', 'n_tokens_mistral': 564, 'n_tokens_neox': 525, 'n_words': 124}