Who is Koe 🐨

Koe is SciDataUCM's Telegram bot (and yep... the koala of the picture above is Koe!).

Koe is always there to help you out answering your SciDataUCM's related questions.

How can I feed Koe 🍽

Just open a conversation with Koe.

Where does Koe sleep 🛌

Koe uses the python-telegram-bot API to communicate with Telegram servers and open-weather-map to implement /weather.

Running KoeBot locally 🏠

Clone this repository by running the following command in a terminal capable of running git: git clone https://github.com/SciDataUCM/koe-bot.git.

You need to create a bot following Telegram Bots Guide in order to use a personal api key and a botname to run this code locally.

Once you have an api key (token) and a botname, you should modify BOTNAME and TOKEN from koe.py.

Install all the requirements by following the guide below.

Run koe.py by running the following command in a terminal capable of running python: python koe.py. Now the bot should be running so don't stop the execution / don't close the terminal which is running it.

Open a conversation with your bot navigating to the link https://t.me/BOTNAME changing BOTNAME with your botname.

Requirements ⚙️

Besides Python 3.6 we will be using the following packages:

• python-telegram-bot
• requests
• cachetools
• beautifulsoup4
• pytest
• datetime

You can simply install each package using pip as follows:

pip install <package>

Or you can install all the packages needed with the requirements.txt file by running:

pip install -r requirements.txt

Contributing 👩🏽‍💻👨🏻‍💻

Please check our CONTRIBUTING file.

Code of conduct 💕

Please check our CODE OF CONDUCT file.

License 📄

Please read the LICENSE provided in this repo.