fullstudio/aiotg

Asynchronous Python framework for building Telegram bots

aiotg

Asynchronous Python API for building Telegram bots, featuring:

• Easy and declarative API
• Hassle-free setup - no need for SSL certificates or static IP
• Built-in support for analytics via botan.io
• Automatic handling of Telegram API throttling or timeouts

Install it with pip:

pip install aiotg

Then you can create a new bot in few lines:

from aiotg import Bot

bot = Bot(api_token="...")

@bot.command(r"/echo (.+)")
def echo(chat, match):
    return chat.reply(match.group(1))

bot.run()

Now run it with a proper API_TOKEN and it should reply to /echo commands.

The example above looks like a normal synchronous code but it actually returns a coroutine. If you want to make an external request (and that's what bots usually do) just use aiohttp and async/await syntax:

import aiohttp
from aiotg import Bot

bot = Bot(api_token="...")

@bot.command("bitcoin")
async def bitcoin(chat, match):
    url = "https://api.bitcoinaverage.com/ticker/global/USD/"
    async with aiohttp.get(url) as s:
        info = await s.json()
        await chat.send_text(info["24h_avg"])

bot.run()

But what if you just want to write a quick integration and don't need to provide a conversational interface? We've got you covered! You can send messages (or any other media) by constructing a Chat object with user_id or channel name. We even saved you some extra keystrokes by providing handy Channel constructors:

...
channel = bot.channel("@yourchannel")
private = bot.private("1111111")

async def greeter():
    await channel.send_text("Hello from channel!")
    await private.send_text("Why not greet personally?")
...

For a more complete example, take a look at WhatisBot or Music Catalog Bot.

For more information on how to use the project, see the project's documentation. Have a question? Ask it on project's Telegram chat.