<commit_before># edx-django-release-util
Release pipeline utilities for edX independently-deployable applications (IDAs) based on Django.

## Testing
To run tests:
`python manage.py test`<commit_msg>Add install instructions to README.md<commit_after># edx-django-release-util
Release pipeline utilities for edX independently-deployable applications (IDAs) based on Django.

## Testing
To run tests:
`python manage.py test`

## Usage
To use in a Django application:
- Add module to requirements.txt/setup.py as a dependency *or* `pip install -e edx-django-release-util` if you have cloned the repo locally.
- Add to `INSTALLED_APPS`:
```python
INSTALLED_APPS = (
    ...
    'release_util',
)
```
{'fraction_non_alphanumeric': 0.10071942446043165, 'fraction_numerical': 0.0, 'mean_word_length': 4.704918032786885, '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': '6139170', 'n_tokens_mistral': 221, 'n_tokens_neox': 203, 'n_words': 75}