<commit_before>user-service
============

Quick Start
-----------

**Installing dependencies**:
	- `pip install -f requirements.txt`
	- I used a `virtualenv` as well: https://virtualenv.pypa.io/en/latest/userguide.html#usage

**Running the app**:
	- `python app.py`
	- The database is created in `/tmp/user-service.db` and populated with some example users
	- App configuration is listed in `default_config.py`.
	- Point the environment variable `USER_SERVICE_SETTINGS` to your own copy of `default_config.py` to change configuration.

**Running the tests**:
	- `python tests.py`

**Building the documentation**:
	- `cd doc; make html`
	- Sphinx must be installed (it is not in requirements.txt since it is only required for docs)
	- `pip install sphinx`
	- In addition, the Sphinx HTTP doc extension is required:
	- `pip install sphinxcontrib-httpdomain`

Design Notes<commit_msg>README formatting<commit_after>user-service
============

Quick Start
-----------

**Installing dependencies**:

	- `pip install -f requirements.txt`
	- I used a `virtualenv` as well: https://virtualenv.pypa.io/en/latest/userguide.html#usage

**Running the app**:

	- `python app.py`
	- The database is created in `/tmp/user-service.db` and populated with some example users
	- App configuration is listed in `default_config.py`.
	- Point the environment variable `USER_SERVICE_SETTINGS` to your own copy of `default_config.py` to change configuration.

**Running the tests**:

	- `python tests.py`

**Building the documentation**:

	- `cd doc; make html`
	- Sphinx must be installed (it is not in requirements.txt since it is only required for docs)
	- `pip install sphinx`
	- In addition, the Sphinx HTTP doc extension is required:
	- `pip install sphinxcontrib-httpdomain`
	- *GitHub unfortunately does not render the docs properly so it must be done manually*

Design Notes
{'fraction_non_alphanumeric': 0.12109795479009688, 'fraction_numerical': 0.0, 'mean_word_length': 3.9839142091152815, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, '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': '583220', 'n_tokens_mistral': 564, 'n_tokens_neox': 546, 'n_words': 210}