<commit_before>regulations-core
================

An engine that supplies the API that allows users to read regulations and their various layers. 

## Configurable Read and Write Endpoints

The read-only end points can be activated by delegating to *regcore.urls*
and turning on the *regcore* and *regcore_read*; write end points can be
activated by turning on *regcore_write*.

## Configuration-Dependent Libraries

This app can be configured with multiple backends. Elastic Search could be
used for both data and search; Django Models can be used for data; Haystack
(1.2.7) can be used for search (e.g. with Solr).

Optional libraries, then are

* django-haystack==1.2.7
* pyelasticsearch
* pysolr
* south

## Elastic Search For Data and Search

If *pyelasticsearch* is installed, you can use Elastic Search for all of
your needs. For a search end point, use *regcore_read.views.es_search.search* 
and use the following backend configuration:

```python
BACKENDS = {<commit_msg>end point -> endpoint<commit_after>regulations-core
================

An engine that supplies the API that allows users to read regulations and their various layers. 

## Configurable Read and Write Endpoints

The read-only endpoints can be activated by delegating to *regcore.urls*
and turning on the *regcore* and *regcore_read*; write endpoints can be
activated by turning on *regcore_write*.

## Configuration-Dependent Libraries

This app can be configured with multiple backends. Elastic Search could be
used for both data and search; Django Models can be used for data; Haystack
(1.2.7) can be used for search (e.g. with Solr).

Optional libraries, then are

* django-haystack==1.2.7
* pyelasticsearch
* pysolr
* south

## Elastic Search For Data and Search

If *pyelasticsearch* is installed, you can use Elastic Search for all of
your needs. For a search endpoint, use *regcore_read.views.es_search.search* 
and use the following backend configuration:

```python
BACKENDS = {
{'fraction_non_alphanumeric': 0.08040712468193384, 'fraction_numerical': 0.0061068702290076335, 'mean_word_length': 4.748538011695906, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 4, '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': '5334520', 'n_tokens_mistral': 551, 'n_tokens_neox': 542, 'n_words': 259}