<commit_before>.. _getstarted:

Get started
===========

Installing django-antispam
--------------------------

The package can be installed using::

    pip install django-antispam


Configuration
-------------

Add the following settings::

    INSTALLED_APPS += (
        'antispam',
    )

    # to use Akismet protection

    AKISMET_API_KEY = '<akismet api-key>'

    AKISMET_SITE_URL = '<base site url>'

    AKISMET_TEST_MODE = False

<commit_msg>docs: make `get started` section flat (remove 2nd level headings)<commit_after>.. _getstarted:

Get started
===========

The package can be installed using::

    pip install django-antispam

Add the following settings::

    INSTALLED_APPS += (
        'antispam',
    )

    # to use Akismet protection

    AKISMET_API_KEY = '<akismet api-key>'

    AKISMET_SITE_URL = '<base site url>'

    AKISMET_TEST_MODE = False


{'fraction_non_alphanumeric': 0.14709236031927023, 'fraction_numerical': 0.0011402508551881414, 'mean_word_length': 2.689075630252101, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, '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': '3350123', 'n_tokens_mistral': 305, 'n_tokens_neox': 268, 'n_words': 76}