<commit_before><commit_msg>completed README file<commit_after>Setup
-----

1. Create a new virtualenv
2. Install the dependencies:

    ```$ pip install -r requirements.txt```
3. Export the environment variables of the project:

    ```
    $ export FLASK_APP=movie_recommendations/__init__.py
    $ export FLASK_DEBUG=1
    ```

Generating the Database
-----------------------

1. Initialize the database: ```$ flask init_db```
2. Fill it with mock data: ```$ flask generate_user_network```
3. (optional) Fill it with a dataset info:
    1. Download the dataset from: [https://www.kaggle.com/deepmatrix/imdb-5000-movie-dataset]()
    2. Import it using: ```$ flask import_movie_dataset movie_metadata.csv```

Running the server
------------------

Use any of the following:
* ```$ flask run```
* ```$ python run.py```

{'fraction_non_alphanumeric': 0.17582417582417584, 'fraction_numerical': 0.015873015873015872, 'mean_word_length': 3.1414141414141414, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5743111', 'n_tokens_mistral': 258, 'n_tokens_neox': 241, 'n_words': 78}