Skip to content

Setting up

Lazaro Raul edited this page Nov 10, 2020 · 3 revisions

As you can see in README, this app is a Telegram bot, so in order to use it you need a Telegram's account.

This wiki assumes that you have already downloaded or cloned the project as explained in the README.

Setup & Requirements

The bot was developed using Python >= 3.7.2 and python-telegram-bot. To install the requirements of the project, you need to have Python installed on your PC, as well as pip. Usually pip comes with python, but if you have issues to have a pip version in your OS, then check this page.

Finally, to install the requirements execute from the command line in your current OS:

pip install -r requirements.txt

Bot Configuration

To use the app, you'll need to own a bot. Check here to know how to create a bot and get an Access Token. Don't worry, everything is free :).

The app gets your Access Token from a config.ini file in the project's root by default. If you want to run the app with a custom config.ini file path, execute it with the -c or --config arg, followed by the path.

The config.ini file must follow this pattern:

[bot]
token=<Your Token Here>

Now you should have everything you need to run your bot with the features and likes of the Matcom Scheduler bot, please, don't forget to star the repo ;) and to share your thoughts with us using the Contact info.

Check the README to see an example of the execution of the app.