Asynchronous Python API for building Telegram bots
Project description
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 chatbase.com
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, Chat
bot = Bot(api_token="...")
@bot.command(r"/echo (.+)")
def echo(chat: 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, Chat
bot = Bot(api_token="...")
@bot.command("bitcoin")
async def bitcoin(chat: Chat, match):
url = "https://apiv2.bitcoinaverage.com/indices/global/ticker/BTCUSD"
async with aiohttp.ClientSession() as session:
response = await session.get(url)
info = await response.json()
await chat.send_text(str(info["averages"]["day"]))
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?")
...
Examples
For a real world example, take a look at WhatisBot or Music Catalog Bot.
For more information on how to use the project, see the project’s documentation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aiotg-2.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05f7f7cccff9dc25e86d54efbfda862032c08302be41d2d207675a61802ac11e |
|
MD5 | ea181e275d641746922837727f8f4d8e |
|
BLAKE2b-256 | b483e183c14ac3aa8a5852fc48b56d7872cc904614040f002e023b68a4c960ea |