/telegram-coffee-bot

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

telegram-coffee-bot

An interactive bot for telegram to schedule events in group chats. (especially, drinking coffee together with friends)

CI


Requirements:

  • Python 3.x
  • pip
    • part of default windows installation
    • linux users can get it via sudo apt install python3-pip
  • virtualenv
    pip install virtualenv

Usage:

  1. Make sure you use virtualenv.
    Install it with pip install virtualenv, then in the repo root, execute virtualenv venv.

  2. Install all dependencies first.
    Do it via pip install -r requirements.txt from repo root.

  3. Have requirements.txt up-to-date.
    After you add a new library via pip install xxxx, make sure you update requirements.txt too via pip freeze --local > requirements.txt

  4. Execute unittests
    Run python -m pytest from repo root.

Nice to know:

We are using Pytest for testing. Read all about it :)