<commit_before>TODO: project name
==================

TODO: project description
-------------------------

TODO: build status icon


### Fuzzy Search

This package provides REST APIs with support for fuzzy (approximate) full-text searching. This allows searching for results with unknown exact contents, as well as searches with spelling mistakes. The returned results are ranked and may be ordered by similarity.

This package requires PostgreSQL and uses its trigram extension (pg_trgm). It provides a queryset filter and optional support viewset mixins.


### Requirements

* Python 3 (tested with 3.6)
* PostgreSQL (tested with 9.6)
* Django (tested with 1.11)
* Django REST Framework (tested with 3.6)


### Basic Usage
<commit_msg>added emphasis<commit_after>TODO: project name
==================

TODO: project description
-------------------------

TODO: build status icon


### Fuzzy Search

This package provides REST APIs with support for fuzzy (approximate) full-text searching. This allows searching for results with unknown exact contents, as well as searches with spelling mistakes. The returned results are ranked and may be ordered by similarity.

This package requires *PostgreSQL* and uses its trigram extension (*pg_trgm*). It provides a queryset filter and optional support viewset mixins.


### Requirements

* Python 3 (tested with 3.6)
* PostgreSQL (tested with 9.6)
* Django (tested with 1.11)
* Django REST Framework (tested with 3.6)


### Basic Usage

{'fraction_non_alphanumeric': 0.11764705882352941, 'fraction_numerical': 0.013522650439486139, 'mean_word_length': 3.966442953020134, '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': '2726156', 'n_tokens_mistral': 422, 'n_tokens_neox': 361, 'n_words': 187}