<commit_before>django-appconf
==============

.. image:: http://codecov.io/github/django-compressor/django-appconf/coverage.svg?branch=develop
    :alt: Code Coverage
    :target: http://codecov.io/github/django-compressor/django-appconf?branch=develop

.. image:: https://secure.travis-ci.org/django-compressor/django-appconf.png?branch=develop
    :alt: Build Status
    :target: http://travis-ci.org/django-compressor/django-appconf

A helper class for handling configuration defaults of packaged Django
apps gracefully.

.. note::

    This app precedes Django's own AppConfig_ classes that act as
    "objects [to] store metadata for an application" inside Django's
    app loading mechanism. In other words, they solve a related but
    different use case than django-appconf and can't easily be used
    as a replacement. The similarity in name is purely coincidental.

.. _AppConfig: https://docs.djangoproject.com/en/stable/ref/applications/#django.apps.AppConfig

Overview
--------

Say you have an app called ``myapp`` with a few defaults, which you want
to refer to in the app's code without repeating yourself all the time.
``appconf`` provides a simple class to implement those defaults. Simply add
something like the following code somewhere in your app files::
<commit_msg>Updates README.rst with svg badge (#38)<commit_after>django-appconf
==============

.. image:: http://codecov.io/github/django-compressor/django-appconf/coverage.svg?branch=develop
    :alt: Code Coverage
    :target: http://codecov.io/github/django-compressor/django-appconf?branch=develop

.. image:: https://secure.travis-ci.org/django-compressor/django-appconf.svg?branch=develop
    :alt: Build Status
    :target: http://travis-ci.org/django-compressor/django-appconf

A helper class for handling configuration defaults of packaged Django
apps gracefully.

.. note::

    This app precedes Django's own AppConfig_ classes that act as
    "objects [to] store metadata for an application" inside Django's
    app loading mechanism. In other words, they solve a related but
    different use case than django-appconf and can't easily be used
    as a replacement. The similarity in name is purely coincidental.

.. _AppConfig: https://docs.djangoproject.com/en/stable/ref/applications/#django.apps.AppConfig

Overview
--------

Say you have an app called ``myapp`` with a few defaults, which you want
to refer to in the app's code without repeating yourself all the time.
``appconf`` provides a simple class to implement those defaults. Simply add
something like the following code somewhere in your app files::

{'fraction_non_alphanumeric': 0.10522273425499232, 'fraction_numerical': 0.0007680491551459293, 'mean_word_length': 4.1380670611439845, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, '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': '2293790', 'n_tokens_mistral': 739, 'n_tokens_neox': 705, 'n_words': 263}