Powerful aiogram template

Telegram Bot API template, with aiogram, peewee and docker

Navigation

* Getting started * Simple use template * Configure environment variables * Bot settings * Database * Redis * Webhook * Docker * Start bot * Manage bot container * View bot logs * Restart bot * Stop bot * Database postgres * Manage postgres via psql * Migrations * Create revision * Upgrade database * Backup and restore * Dump database * Restore database * I18n locales * Create locales * Update locales * Bot structure * Auto deploy * Configure secrets

Getting started

Simple use template

Click here to create repository from this template or:

$ git clone https://github.com/netbriler/aiogram-peewee-template <your project name> $ cd <your project name> $ pip install -r requirements.txt

initialize database
$ pwmigrate migrate --database $(python getdatabaseurl.py) --directory ./migrations
or if you have make you can simply type 
$ make db_upgrade
run pooling
$ python app.py
or webhook
$ python webhook.py

Configure environment variables

$ cp .env.dist .env

$ vim .env
or 
$ nano .env

Bot settings:

ADMINS - administrators ids divided by ,

# example ADMINS=12345678,12345677,12345676 
or one admin
 ADMINS=12345678

# example BOT_TOKEN=123452345243:Asdfasdfasf

# example RATE_LIMIT=0.5 # seconds

# example TELEGRAMTESTSERVER=true # enabled TELEGRAMTESTSERVER=false # disabled

# Dababase postgres
DATABASE_USER=<some username>
DATABASE_PASS=<some password>
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_NAME=<some database name>

# example REDIS_HOST=redis REDIS_PORT=6379 REDIS_DB=5

# example
WEBHOOK_PORT=8080                                # run webhook on port
WEBHOOK_HOST=https://example.com         # webhook domain must be https
WEBHOOK_PATH=/path/to/webhook            # some custom path to webhook where telegram will send updates

# grant execution rights
$ chmod +x ./bin/entrypoint.sh
$ docker-compose up -d --force-recreate 
or if you have make you can simply type 
 $ make run 
or only make
 $ make

$ docker-compose exec bot /bin/bash 
or if you have make you can simply type 
 $ make exec

$ docker-compose logs -f bot 
or if you have make you can simply type 
 $ make logs

$ docker-compose restart bot 
or if you have make you can simply type 
 $ make restart

$ docker-compose build --no-cache 
or if you have make you can simply type 
 $ make build

$ docker-compose stop 
or if you have make you can simply type 
 $ make stop

$ docker-compose exec postgres psql -U postgres postgres 
or if you have make you can simply type 
 $ make psql

$ pwmigrate create --auto --database $(python getdatabaseurl.py) --directory ./migrations "<some revision message>" 
or if you have make you can simply type 
 $ make db_revision "<some revision message>"

$ pwmigrate migrate --database $(python getdatabaseurl.py) --directory ./migrations 
or if you have make you can simply type 
 $ make db_upgrade

Backup and restore

Dump database

$ mkdir -p data/backups/postgres && docker-compose exec -T postgres pgdump -U postgres postgres --no-owner | gzip -9 > data/backups/postgres/backup-$(shell date +%Y-%m-%d%H-%M-%S).sql.gz
or if you have make you can simply type 
$ make pg_dump

Restore database

$ mkdir -p data/backups/postgres && bash ./bin/pg_restore.sh
or if you have make you can simply type 
$ make pg_restore

I18n locales

Create locales

first you should extract all messages from bot

$ pybabel extract --input-dirs=. -o data/locales/bot.pot --project=bot 
or if you have make you can simply type 
 $ make pybabel_extract

$ pybabel init -i data/locales/bot.pot -d data/locales -D bot -l <language code> 
or if you have make you can simply type 
 $ make pybabel_init <language code>

$ pybabel compile -d data/locales -D bot --statistics 
or if you have make you can simply type 
 $ make pybabel_compile

Update locales

$ pybabel update -i data/locales/bot.pot -d data/locales -D bot 
or if you have make you can simply type 
 $ make pybabel_update

Bot structure

├───bin                 # some bath scripts for docker
├───bot
│   ├───filters         # some aiogram filters
│   ├───handlers
│   │   ├───errors      # error handlers
│   │   └───users       # message handlers
│   ├───keyboards
│   │   ├───default     # aiogram markups
│   │   └───inline      # aiogram inline markups
│   ├───middlewares     # aiogram middlewares
│   └───states          # aiogram states
├───data
│   ├───backups         # database backups
│   │   └───postgres
│   ├───locales         # i18n locales
│   └───logs            # bot logs
├───models              # database models
├───services            # database services
└───utils               # some helpful things

Auto deploy

Configure secrets

HOST - ssh server

PORT - ssh server port, by default 22

USERNAME - ssh username

KEY - private ssh key

PROJECT_PATH - path to your cloned repository