Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 2.31 KB

README.md

File metadata and controls

58 lines (34 loc) · 2.31 KB
Raw

Dog Pics Bot

A simple Telegram bot that sends random dog pictures (and more!).

You can test the bot on Telegram, just click here: @DogPicsBot.

Currently on v3.0.0. For more information about versions and changes, refer to the changelog.

Requirements

The bot runs on Python 3 (officially supporting Python 3.10 to 3.12), and depends on packages listed on the requirements.txt file.

For ease of use, use poetry to install dependencies with the following command:

poetry install

Installation

Simply clone this repository, install the requirements with poetry then set a new environment variable named DPB_TG_TOKEN with your Telegram bot API token. If you don't have a valid token, check out this guide.

Note that one feature (sending dog pictures freely through group chats on certain trigger words) requires the bot's Privacy Mode to be disabled (this can be done through @BotFather).

Usage

Run the following command on a command line. It will keep the polling thread running (therefore keeping your bot alive) until you kill the process.

poetry run python bot.py

Test

Unit tests for the bot are found in the tests.py file. You can run them with verbose output after setting up your local environment, including the 80% coverage check that is expected of the repository, with the following command:

poetry run pytest

What's next

The next features to be developed are:

  • Let the dog detect and reply to images that contain dogs in them (reference)
  • Replying "intelligently" to messages relating to dogs (e.g. emotions)
  • Explore the use of other dog pics APIs
  • And more!

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

All contributions that involve changing the codebase should either include or update tests, and make sure that all tests pass before changes can be merged to the master branch.

License

This project is licensed under the MIT License - see the LICENSE file for details.