<commit_before>.. _installation:

Installation
============

* To install ::
    
    pip install django-jsonfield
    pip install eventlog

* Add ``'eventlog'`` to your ``INSTALLED_APPS`` setting::

    INSTALLED_APPS = (
        # other apps
        "eventlog",
    )


Optionally
----------

* Configure Pusher::

    PUSHER_CONFIG = {
        "app_id": "<app_id>",
        "key": "<key>",
        "secret": "<secret>"
    }<commit_msg>Documentation update. Fixes #2<commit_after>.. _installation:

Installation
============

* To install ::
    
    pip install eventlog

* Add ``'eventlog'`` to your ``INSTALLED_APPS`` setting::

    INSTALLED_APPS = (
        # other apps
        "eventlog",
    )


Optionally
----------

* Configure Pusher::

    PUSHER_CONFIG = {
        "app_id": "<app_id>",
        "key": "<key>",
        "secret": "<secret>"
    }
{'fraction_non_alphanumeric': 0.18909512761020883, 'fraction_numerical': 0.001160092807424594, 'mean_word_length': 2.2813688212927756, 'pattern_counts': {'":': 6, '<': 9, '<?xml version=': 0, '>': 9, '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': '880540', 'n_tokens_mistral': 290, 'n_tokens_neox': 278, 'n_words': 62}