Get notifications when your lessons are reviewed!

Python should already be installed. This project is tested on Python 3.10 and 3.11. You may use other versions as you will, but YMMV.

Clone the repo / download code

Using virtual environment virtualenv/venv is recommended for project isolation.

Install requirements:

pip install -r requirements.txt

Set up environmental variables.
Create .env file in root folder and write down the following variables:

• DEVMAN_AUTH - Devman API user access token. Get it from the API docs.
• TELEGRAM_BOT_TOKEN - Access token of your bot. You get one from BotFather Telegram bot when you create a bot.
• TELEGRAM_LOGGING_BOT_TOKEN - same as above, but used for sending logs. Can be the same bot or separate as the main one.
• TELEGRAM_USER_ID - Your numeric Telegram ID to send logging messages. Can be checked by writing to special user info bot.
• LOG_LEVEL - (Optional) Sets the threshold for this logger. Accepts numbers or strings (such as 10 or "DEBUG" for DEBUG level)

If run on Windows, long-polling requests won't allow to stop the program (by using Ctrl+C) until they finish. Thus, using WSL might be useful.

The project contains Dockerfile to build Docker container. If you already have Docker installed, after cloning the repository, run the following:

docker build -t notification-bot .

-t notification-bot is setting the tag to the container for the ease of further use. . tells docker to look for Dockerfile in the current path (so make sure to run the command from the root folder of the project)

After the container is built, run it:

docker run -d --env-file ./.env --name notification_bot notification_bot

-d runs the container in the background allowing you to continue using the terminal.
--env-file ./.env tells docker to load enviromental variables from .env file. You can also use another path and/or file or simply state the variables by using -e argument (e.g. -e VAR1=value). Note that when using --env-file, .env file should be strictly written in VAR=value format, without quotation marks or spaces (so, not VAR="value" or VAR = value) as docker won't parse the variables correctly otherwise.
--name notification_bot sets the name of the container.
notification_bot is the tag of the container you've set on the previous step with -t.

Run the script:

python main.py

If that's your first interaction with your bot, send it a /start command, or it won't be able to send you messages.

And you're all set! When you get updates on your submitted lessons, you'll receive a message from the bot.

The code is written for educational purposes on online-course for web-developers dvmn.org.