zirochkaa / gif-sender-bot

Telegram bot designed for sending specific GIF to annoying person or even people.

GIF Sender

This repository contains pet project - telegram bot designed for sending specific GIF to annoying person or even people :)

Link to the working telegram bot here - @GIFSenderBot (currently shut down).

Run project locally

1. Setup and activate your local python environment. Here are few guides on how to do it.
2. Install requirements:

   pip install -r requirements-ci.txt

3. Create .env file:

   cp app/.env.template app/.env

4. Update TELEGRAM_USERNAMES in .env file - it should contain comma separated list of usernames (like username1,username2,username3) to which bot will respond.
5. Obtain Telegram Bot Token by creating Telegram Bot. Here (Obtain Your Bot Token section) is a guide on how to do it. Update TELEGRAM_BOT_TOKEN in .env file.
6. This app uses a webhook approach to processing bot updates. In order to do it your localhost has to be put on the internet. You can achieve this by using ngrok. You need to install it and run:

   ./ngrok http 8000

   After running above command you will see something like this:

You will need to copy Forwarding part (for example, on the screenshot it will be https://03d2-146-70-181-35.ngrok-free.app) and update APP_BASE_URL in .env file.

7. It's time to run application:

   uvicorn app.run:app --reload

8. Go to 127.0.0.1:8000 in your web browser.

Tests

To run tests use following command:

pytest tests/

If you want to check code coverage use following command:

pytest --cov-config=.coveragerc --cov=app tests/