<commit_before># sPyChat

```
virtualenv -p python3 .
source bin/activate
pip install pycrypto
pip install pycap
```

# Run demo

```
python3 bob.py
python3 alice.py
```<commit_msg>expanded README documentation<commit_after># sPyChat

### Python setup

To properly use this python-modules some additional libraries have to be
installed beforehand. This can be easily accomplished with the commands below.

```
virtualenv -p python3 .
source bin/activate
pip install pycrypto
pip install pycap
```

### Run demo

This software ships with two demo-scripts containing a sample implementation of
an encrypted communication. To test them, just enter the commands below.

```
python3 bob.py
python3 alice.py
```

**WARNING: The provided secure protocol implementation is just for exercise
purposes and should not be used in real world implementations because of some
major vulnerabilities (They were requested in the problem statement.)!**
{'fraction_non_alphanumeric': 0.06966773847802786, 'fraction_numerical': 0.006430868167202572, 'mean_word_length': 4.949044585987261, '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': '4761020', 'n_tokens_mistral': 255, 'n_tokens_neox': 237, 'n_words': 118}