Skip to content

Latest commit

 

History

History
69 lines (55 loc) · 1.93 KB

README.md

File metadata and controls

69 lines (55 loc) · 1.93 KB

Chat Nuff Bot

This is a Telegram bot that summarizes chats. It can give you the gist of the last N messages within the chat.

Requisites

  • Docker
  • Python 3.12+

How to run

  1. Create a .env file based on .env.template.
  2. Fill in the API keys as required. Use your own keys, or ask the maintainers.

A. Using Rye

It's suggested to use the python build tool, Rye. Installation guides can be found on their site.

After Rye is installed, you run the following:

  1. Initialize the virtual environment and download the dependencies rye sync
  2. Run the application via a run script rye run dev
  3. Stop the application via a run script rye run stop

B. Spinning Docker up manually

You can run the application as a docker containers with the following.

docker-compose up -d --build

This will build the images for you then run them in a detached mode. If you do not need to build the images, you can use the following command.

docker-compose up -d

Building only the app image

Use the following command to build the image

docker build . -t <tag-the-image>

C. Running from PyCharm

  1. Create a run config using main.py
  2. Set an LOCAL env variable (optional)
  3. Start the Redis database locally rye run redis
  4. Run main.py

Testing

This project contains tests. We use Pytest for the testing framework. Tests can be run 2 ways:

A. Using Rye

rye run tests

This executes the Rye test script.

B. Using Pytest directly

pytest -n auto tests --spec

Runs Pytest in a parallel mode. Note: We create atom tests that facilitate this. Meaning, our practice is not writing tests that share state, or depending on the results from other tests.

Notes

The application requires a Redis cache to store messages. docker-compose up -d will spin up a cache for you. But if you decide to use a different version, you'll have to get the images from Redis' official Docker hub.