peyk

An aiogram-style async bot library for Telegram, Bale, and Rubika.

10-line quickstart

from peyk import Bot

bot = Bot("TOKEN", platform="telegram")

@bot.command("start")
async def start(message):
    await message.answer("Hello from peyk!")

@bot.message()
async def echo(message):
    await message.answer(message.text or "")

bot.run()

platform= is selected once when the bot is created; handlers, filters, keyboards, and normalized message objects stay platform-neutral.

Install

pip install peyk

For development:

pip install -e ".[dev]"

Documentation

• Capabilities — audited feature support and UNKNOWN areas.
• Migration from aiogram — import mapping, compatible surfaces, and Peyk-specific differences.
• Quickstart — simple bot.run() first, then Dispatcher/Router.
• Examples — runnable examples using public imports.

Tests

pytest

The test suite is offline and uses local/fake servers and in-memory/fakeredis fixtures.

Project record

See docs/decisions.md for the architectural decision record and capability evidence.

Publishing

See PUBLISHING.md for the one-time GitHub/PyPI setup and the release checklist for every version after that.

License

MIT — see LICENSE.