Skip to main content

Lightweight wrapper over aiogram 3.x

Project description

re_aiogram

re_aiogram is a lightweight wrapper over aiogram 3.x that keeps the familiar aiogram API while simplifying bot development and adding extra features.

The goal of the project is to stay fully compatible with aiogram, but provide a cleaner and more convenient developer experience.


Install

pip install re_aiogram
import re_aiogram

Features

  • familiar aiogram-style API
  • simplified bot startup without explicit dispatcher
  • router auto-loading
  • built-in MediaGroup support
  • aiogram-compatible imports
  • simple and intuitive keyboard builder

Quick Start

from re_aiogram import Bot, Message
from re_aiogram.filters import Command

bot = Bot(token="YOUR_API_TOKEN")


@bot.message(Command("start"))
async def cmd_start(message: Message):
    await message.answer(
        "Hi! I am a Telegram bot powered by re_aiogram!"
    )


bot.run(logging_enabled=True)

You can specify a token from the virtual environment:

bot = Bot(env_token="API_TOKEN")

SimpleKeyboard

SimpleKeyboard provides a fast and intuitive way to create inline and reply keyboards with minimal boilerplate.

from re_aiogram import SimpleKeyboard

Inline keyboard

@bot.message(Command("inline_keyboard"))
async def inline_keyboard(message: Message):
    kb = (
        SimpleKeyboard.inline()
        .row(
            ("👤 Profile", "profile"),
            ("⚙ Settings", "settings")
        )
        .row(
            ("❌ Close", "close")
        )
    )

    await message.answer(
        "Inline keyboard",
        reply_markup=kb()
    )

You can also automatically arrange buttons using adjust:

kb = (
    SimpleKeyboard.inline()
    .buttons(
        ("1", "1"),
        ("2", "2"),
        ("3", "3"),
        ("4", "4"),
        adjust=2
    )
)

Reply keyboard

@bot.message(Command("reply_keyboard"))
async def reply_keyboard(message: Message):
    kb = (
        SimpleKeyboard.reply(resize_keyboard=True)
        .row("👤 Profile", "⚙ Settings")
        .row("❌ Close")
    )

    await message.answer(
        "Reply keyboard",
        reply_markup=kb()
    )

Clear keyboard

@bot.message(Command("clear_keyboard"))
async def clear_keyboard(message: Message):
    kb = (
        SimpleKeyboard.reply()
        .clear()
    )

    await message.answer(
        "Reply keyboard was removed",
        reply_markup=kb()
    )

MediaGroup Handler

Built-in support for Telegram media groups.

from re_aiogram import Bot, Message
from re_aiogram.filters import F
from re_aiogram.types import MediaGroup

bot = Bot(token="YOUR_API_TOKEN")


@bot.message(F.media_group_id)
async def handle_album(message: Message, media_group: MediaGroup):
    await message.answer_media_group(media_group)

media_group contains the collected media group messages.

Properties

Property Description
media_group.count Returns the number of media items in the group.
media_group.caption Returns the first caption found in the group (Telegram sends caption only on the first item). Returns None if no caption is present.
media_group.captions Returns a list of all captions from the group.
media_group.messages Returns a copy of the original Message objects from the group.
media_group.photos Returns a list of Message objects that contain photos.
media_group.videos Returns a list of Message objects that contain videos.
media_group.documents Returns a list of Message objects that contain documents.
media_group.audio Returns a list of Message objects that contain audio files.
media_group.is_mixed Returns True if the album contains different media types (e.g. photos and videos together).

Routers

Router connection is simplified with bot.load()

Project structure

project/
│
├── main.py
└── handlers/
    └── start.py

main.py

from re_aiogram import Bot

bot = Bot(token="YOUR_API_TOKEN")

bot.load("handlers.start")

bot.run(logging_enabled=True)

handlers/start.py

from re_aiogram import router, Message
from re_aiogram.filters import Command


@router.message(Command("start"))
async def start(message: Message):
    await message.answer("Router connected!")

Future improvements

These features are planned for upcoming versions and are not yet part of the core API.

Flow System (FSM alternative)

A lightweight state/flow system replacing traditional FSM:

  • step-based flow control
  • ctx.next() and ctx.back()
  • shared ctx.data
  • parallel flows via scope()
  • simple chain-based conversation handling

Example concept:

@router.message(Command("register"))
async def register(message: Message, ctx: FlowContext):
    await message.answer("What is your name?")
    ctx.next(get_name)

Philosophy

re_aiogram tries to make Telegram bot development:

  • simpler
  • cleaner
  • less boilerplate-heavy
  • more beginner-friendly

while still preserving compatibility with the aiogram ecosystem.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

re_aiogram-0.1.2.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

re_aiogram-0.1.2-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

Details for the file re_aiogram-0.1.2.tar.gz.

File metadata

  • Download URL: re_aiogram-0.1.2.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for re_aiogram-0.1.2.tar.gz
Algorithm Hash digest
SHA256 4e2a9f6fe6b5b11e200e9d4941fee69ed9ef06916a29d58b8eb9237b6138edd8
MD5 ab98b50d998e120bc2aa444defceaad5
BLAKE2b-256 e91d2716d1ee8bbb8781c6fc9e840987645bb31eb3f84cf572aba5ae8700a5dc

See more details on using hashes here.

File details

Details for the file re_aiogram-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: re_aiogram-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 14.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for re_aiogram-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 aa7c1fac202bba047805410c7654023b6566581d528e1507f22724ea1ecb6f4a
MD5 51124a2bbb14711c09c2c8fe8f0b6a5b
BLAKE2b-256 d10b89344d29e0fcd096f2f804664cabcab31f9c4d152ac8d9ec8aa246acb14a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page