davtelepot/README.md

davtelepot

This project conveniently mirrors the Telegram bot API with the class Bot.

Please note that you need Python3.5+ to run async code.

Check requirements.txt for third party dependencies.

Check out help(Bot) for detailed information.

Project folders

data folder

• *.db: databases used by bots
• *.log: log files (store log_file_name and errors_file_name in data/config.py module)
• passwords.py: contains secret information to be git-ignored (e.g. bot tokens)

my_token = 'token_of_bot1'
my_other_token = 'token_of_bot2'
...

Usage

import sys
from davtelepot.bot import Bot
from data.passwords import my_token, my_other_token

long_polling_bot = Bot(token=my_token, database_url='my_db')
webhook_bot = Bot(token=my_other_token, hostname='example.com',
                  certificate='path/to/certificate.pem',
                  database_url='my_other_db')

@long_polling_bot.command('/foo')
async def foo_command(bot, update, user_record):
  return "Bar!"

@webhook_bot.command('/bar')
async def bar_command(bot, update, user_record):
  return "Foo!"

exit_state = Bot.run()
sys.exit(exit_state)

Check out help(Bot) for detailed information.

Webhook additional information

To run a bot in webhook modality, you have to provide a hostname and certificate at bot instantiation and a local_host and port when calling Bot.run method.

• Telegram will send POST requests at https://{hostname}/webhook/{tokens}/ using certificate for encryption
• aiohttp.web.Application server will listen http://{local_host}:{port} for updates

It is therefore required a reverse proxy passing incoming requests to local_host.

Example of nginx reverse proxy serving this purpose

server {
  listen 8553 ssl;
  listen [::]:8553 ssl;

  server_name example.com www.example.com;

  location /telegram/ {
     proxy_pass http://127.0.0.5:8552/;
  }

  ssl_certificate /path/to/fullchain.pem;
  ssl_certificate_key /path/to/privkey.pem;
}

Example of python configuration file in this situation

# File config.py, gitignored and imported in main script
hostname = "https://www.example.com:8553/telegram"
certificate = "/path/to/fullchain.pem"
local_host = "127.0.0.5"
port = 8552