mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-08 17:13:56 +00:00
79 lines
3 KiB
Markdown
79 lines
3 KiB
Markdown
# Overview
|
|
|
|
Documentation for version 3.0 [WIP] [^1]
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
|
[](https://pypi.python.org/pypi/aiogram)
|
|
[](https://core.telegram.org/bots/api)
|
|
[](https://github.com/aiogram/aiogram/actions)
|
|
[](https://pypi.python.org/pypi/aiogram)
|
|
[](https://pypi.python.org/pypi/aiogram)
|
|
[](https://pypi.python.org/pypi/aiogram)
|
|
[![\[Telegram\] aiogram live](https://img.shields.io/badge/telegram-aiogram-blue.svg)](https://t.me/aiogram_live)
|
|
|
|
**aiogram** modern and fully asynchronous framework for [Telegram Bot API](https://core.telegram.org/bots/api) written in Python 3.7 with [asyncio](https://docs.python.org/3/library/asyncio.html) and [aiohttp](https://github.com/aio-libs/aiohttp). It helps you to make your bots faster and simpler.
|
|
|
|
|
|
## Features
|
|
|
|
- Asynchronous ([asyncio docs](https://docs.python.org/3/library/asyncio.html), [PEP-492](https://www.python.org/dev/peps/pep-0492/))
|
|
- [Supports Telegram Bot API v{!_api_version.md!}](api/index.md)
|
|
- [Updates router](dispatcher/index.md) (Blueprints)
|
|
- Finite State Machine
|
|
- [Middlewares](dispatcher/middlewares/index.md)
|
|
- [Replies into Webhook](https://core.telegram.org/bots/faq#how-can-i-make-requests-in-response-to-updates)
|
|
|
|
|
|
!!! note
|
|
Before start using **aiogram** is highly recommend to know how to work with [asyncio](https://docs.python.org/3/library/asyncio.html).
|
|
|
|
Also if you has questions you can go to our community chats in Telegram:
|
|
|
|
- [English language](https://t.me/aiogram)
|
|
- [Russian language](https://t.me/aiogram_ru)
|
|
|
|
|
|
## Example
|
|
|
|
Simple usage
|
|
```python3
|
|
from aiogram import Bot, Dispatcher, types
|
|
from aiogram.dispatcher.handler import MessageHandler
|
|
|
|
TOKEN = "42:TOKEN"
|
|
dp = Dispatcher()
|
|
|
|
|
|
@dp.message(commands=["start"])
|
|
class MyHandler(MessageHandler):
|
|
"""
|
|
This handler receive messages with `/start` command
|
|
"""
|
|
|
|
async def handle(self):
|
|
await self.event.answer(f"<b>Hello, {self.from_user.full_name}!</b>")
|
|
|
|
|
|
@dp.message(content_types=[types.ContentType.ANY])
|
|
async def echo_handler(message: types.Message, bot: Bot):
|
|
"""
|
|
Handler will forward received message back to the sender
|
|
"""
|
|
await bot.forward_message(
|
|
from_chat_id=message.chat.id, chat_id=message.chat.id, message_id=message.message_id
|
|
)
|
|
|
|
|
|
def main():
|
|
bot = Bot(TOKEN, parse_mode="HTML")
|
|
dp.run_polling(bot)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|
|
```
|
|
|
|
## Task list for 3.0
|
|
Partial list of plans for this big release is listed [here](todo.md).
|
|
|
|
[^1]: work in progress
|