<commit_before>Bungiesearch
============

|Build Status| |Coverage Status|

Purpose
=======

Bungiesearch is a Django wrapper for
`elasticsearch-dsl-py <https://github.com/elasticsearch/elasticsearch-dsl-py>`__.
It inherits from elasticsearch-dsl-py's ``Search`` class, so all the
fabulous features developed by the elasticsearch-dsl-py team are also
available in Bungiesearch. In addition, just like ``Search``,
Bungiesearch is a lazy searching class (and iterable), meaning you can
call functions in a row, or do something like the following.

.. code:: python<commit_msg>Added TOC to README.<commit_after>Bungiesearch
============

|Build Status| |Coverage Status|

.. contents::

Purpose
=======

Bungiesearch is a Django wrapper for
`elasticsearch-dsl-py <https://github.com/elasticsearch/elasticsearch-dsl-py>`__.
It inherits from elasticsearch-dsl-py's ``Search`` class, so all the
fabulous features developed by the elasticsearch-dsl-py team are also
available in Bungiesearch. In addition, just like ``Search``,
Bungiesearch is a lazy searching class (and iterable), meaning you can
call functions in a row, or do something like the following.

.. code:: python
{'fraction_non_alphanumeric': 0.1188034188034188, 'fraction_numerical': 0.0, 'mean_word_length': 5.295698924731183, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, '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': '5159742', 'n_tokens_mistral': 343, 'n_tokens_neox': 336, 'n_words': 131}