<commit_before># OmNomNom

OmNomNom is a Telegram bot that can tell you what you can eat in some canteens in Berlin (Germany). You can invite the bot to a group or ask it directly.

## How to use it
Usually you do not need to run the bot yourself. You can just talk to the @OmnBot in Telegram. Feel free to invite it in your groups. But if you want to run it anyways or would like to improve the code you can do so by following these steps.

This assumes that you use virtualenv and virtualenvwrapper. Otherwise you can use virtualenv directly without virtualenvwrapper or install the dependencies global.

At first you have to create a bot by talking to Telegrams [BotFather](https://core.telegram.org/bots#6-botfather). Copy your access token and keep it a secret!


```bash
# Create a new env
$ mkvirtualenv omnomnom

# Or use an existing one
$ workon omnomnom

# Checkout the repository
(omnomnom) $ git clone https://github.com/ekeih/OmNomNom.git
(omnomnom) $ cd OmNomNom

# Create a configuration file with your access token
# This line would add your access token to your shell history.
# It would be clever to avoid this by using an editor 
# or temporary disabling the history.
$ echo "AUTH_TOKEN = 'YOUR_ACCESS_TOKEN'" > config.py

# Install dependencies
(omnomnom) $ pip install -r requirements.txt

# Run OmNomNom
(omnomnom) $ python3 main.py
```


## Developer
* <NAME>
* <NAME><commit_msg>updated readme for docker and env support<commit_after># OmNomNom

OmNomNom is a Telegram bot that can tell you what you can eat in some canteens in Berlin (Germany). You can invite the bot to a group or ask it directly.

## How to use it
Usually you do not need to run the bot yourself. You can just talk to the @OmnBot in Telegram. Feel free to invite it in your groups. But if you want to run it anyways or would like to improve the code you can do so by following these steps.

### Docker
```bash
$ docker run --env TELEGRAM_BOT_AUTH_TOKEN='YOUR_ACCESS_TOKEN' ekeih/omnomnom
```

### Virtualenvwrapper
This assumes that you use virtualenv and virtualenvwrapper. Otherwise you can use virtualenv directly without virtualenvwrapper or install the dependencies global.

At first you have to create a bot by talking to Telegrams [BotFather](https://core.telegram.org/bots#6-botfather). Copy your access token and keep it a secret!


```bash
# Create a new env
$ mkvirtualenv omnomnom

# Or use an existing one
$ workon omnomnom

# Checkout the repository
(omnomnom) $ git clone https://github.com/ekeih/OmNomNom.git
(omnomnom) $ cd OmNomNom

# Install dependencies
(omnomnom) $ pip install -r requirements.txt

# Run OmNomNom
(omnomnom) $ TELEGRAM_BOT_AUTH_TOKEN='YOUR_ACCESS_TOKEN' python3 main.py
```

## Developer
* <NAME>
* <NAME>
{'fraction_non_alphanumeric': 0.06722689075630252, 'fraction_numerical': 0.0014614541468761417, 'mean_word_length': 4.326848249027237, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 8, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4163830', 'n_tokens_mistral': 842, 'n_tokens_neox': 794, 'n_words': 391}