<commit_before>José
=========

*The documentation for José is available in English as well as in Portuguese*

*Este arquivo em português pode ser encontrado em [README-pt.md](https://github.com/lkmnds/jose/blob/master/README-pt.md)*

José is a general-purpose bot for Discord written in Python.

**Redis and Python 3.5+ is needed**

Instructions for Linuxes:
```bash
$ git clone https://github.com/lkmnds/jose.git
$ cd jose
$ nano joseconfig.py

# For Debian-based Linuxes
$ sudo apt-get install gettext

# Make sure pip references python 3.5+
$ sudo pip install -U -r requirements.txt
```

Setup a cron job to make backups every hour:
```
0 * * * * /path/to/jose/backup.bash
```

Example `joseconfig.py` file:
```python
discord_token = 'DISCORD OAUTH2 BOT TOKEN'
soundcloud_id = 'SOUNDCLOUD API ID'
jcoin_path = 'jcoin/josecoin.db'
WOLFRAMALPHA_APP_ID = 'WOLFRAM|ALPHA APP ID'
OWM_APIKEY = 'OpenWeatherMap API Key'
MAGICWORD_PATH = 'db/magicwords.json'
```

Run Redis somewhere:
```
redis-server jose/redis.conf
```

Starting:
```
python3 jose-bot.py
```
<commit_msg>README: update it for v2<commit_after>José
=========

Installation
```bash
# You'll need mongo
# and Python 3.6+
git clone https://github.com/lkmnds/jose.git

cd jose

python3.6 -m venv env
env/bin/python3.6 -m pip install -Ur requirements.txt

# fill in stuff from the example config file
# as you wish
nano joseconfig.py

# profit
env/bin/python3.6 jose.py
```

Example config file
```python
# discord stuff
token = 'discord token'
prefix = 'j!'

# api stuff
WOLFRAMALPHA_APP_ID = 'app id for wolframalpha'
OWM_APIKEY = 'api key for OpenWeatherMap'
WEATHER_API = {
    'base_url': 'Base URL for a custom Weather API',
    'key': 'something',
    'secret': 'something',
}

# set those to whatever
SPEAK_PREFIXES = ['josé ', 'José ', 'jose ', 'Jose ']

# enable/disable datadog reporting
datadog = False
```

{'fraction_non_alphanumeric': 0.13059701492537312, 'fraction_numerical': 0.008528784648187633, 'mean_word_length': 4.2873239436619714, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, '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': '6449895', 'n_tokens_mistral': 731, 'n_tokens_neox': 688, 'n_words': 207}