Skip to content

biobdeveloper/zverobot

Repository files navigation

ZveroBot

Telegram License pre-commit Code style: black

Zverobot is the telegram bot created to help homeless pets by DvaPsa (means "Two dogs" on russian) team

Check it out https://t.me/zverobot

Homeless pets always need some money. If you want to support us, you can contact DvaPsa Team at the links above

Currently bot works only for russian-speaking users. But we have big plans :)

Zverobot is fully asynchronous, written on Python 3. Special thanks to the greatest Telegram Bot python library aiogram

How to deploy

If you want to build some telegram bot based on Zverobot experience, here is the instructions how to deploy it on the Linux machine.

We publish source code only for the "bot app" part. So you need some admin backend to control database. I highly recommend to use flask-admin because it is simple, fast, and most importantly - compatible with Sqlalchemy so you don't need to redeclare database models.

Also you can create some command handlers in zverobot/src/tg/handlers/admin_handlers.py file to manage the bot directly from Telegram.

Requirements

Installation in Docker

Install git, Docker, Docker Compose:

sudo apt install git docker.io docker-compose

Clone the repository:

git clone https://github.com/biobdeveloper/zverobot
cd zverobot/

Create configuration files from examples and fill it with your data

cp .env.example .env

If you run it with native docker-compose.yml configuration, create docker network by

sudo docker network create zverobot-network

Start the services by running the command:

sudo docker-compose up

Contributing

You can help by working on opened issues, fixing bugs, creating new features or improving documentation.

License

ZveroBot is released under the MIT License.

Releases

No releases published

Packages

No packages published

Languages