Skip to main content

A lightweight framework for creating Telegram bots with advanced routing and localization.

Project description

Bojango

Bojango — это фреймворк для упрощения разработки Telegram-ботов. Он предоставляет удобные инструменты для маршрутизации, управления экранами, локализации и работы с асинхронными функциями.

Установка

Установить Bojango можно через pip:

pip install bojango

Особенности

  • Маршрутизация: Используйте удобные декораторы для регистрации команд и callback-обработчиков.
  • Управление экранами: Легко создавайте и рендерьте интерфейсы с кнопками.
  • Локализация: Поддержка мультиязычных приложений с помощью gettext.
  • Асинхронная архитектура: Полная поддержка asyncio для высокопроизводительных приложений.
  • Гибкость: Возможность расширения и кастомизации под ваши задачи.

Быстрый старт

from bojango.core.bot import BojangoBot
from bojango.action.screen import ActionScreen
from bojango.core.routing import command, callback


class MyBot(BojangoBot):
  api_token = 'ВАШ_API_ТОКЕН'
  localizer = None  # Опционально: настройте локализацию
  handlers_modules = ['mybot.handlers']  # Укажите модуль(и) с обработчиками


if __name__ == '__main__':
  bot = MyBot()
  bot.run()

Пример обработчика

from bojango.core.routing import command, callback
from bojango.action.screen import ActionScreen, ActionButton

@command('start')
async def start_handler(update, context):
  screen = ActionScreen(
    text='Добро пожаловать!',
    buttons=[[ActionButton(text='Кнопка 1', action_name='button_action')]]
  )
  await screen.render(update, context)

@callback('button_action')
async def button_handler(update, context, args):
  screen = ActionScreen(text='Вы нажали на кнопку!')
  await screen.render(update, context)

Структура проекта

myproject/
│
├── mybot/
│   ├── __init__.py
│   ├── handlers/
│   │   ├── __init__.py
│   │   └── main.py
│   ├── locales/
│   │   ├── en/
│   │   └── ru/
│   └── main.py
│
└── README.md

Требования

  • Python 3.10+
  • Telegram Bot API

Лицензия

Bojango распространяется под лицензией MIT. Подробнее см. в файле LICENSE.

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

bojango-1.0.4.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

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

bojango-1.0.4-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file bojango-1.0.4.tar.gz.

File metadata

  • Download URL: bojango-1.0.4.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for bojango-1.0.4.tar.gz
Algorithm Hash digest
SHA256 02e099f01ce008a7a756a722b35ad4d181b9ef119c623c7154bd6064c051342a
MD5 d37036846abe51e9a8dd9d5a44cd5eb3
BLAKE2b-256 1c05c828d56357ac33cb661a4c8d8180485a360a37380ee51538620d06d63dcb

See more details on using hashes here.

File details

Details for the file bojango-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: bojango-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 15.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for bojango-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4bc5d17a23974c764261c36cbf96f7309581f71993c74cbdc2faff51dd5d6008
MD5 776680088148553f27aa0a5584bf1691
BLAKE2b-256 99f9732cdd052b2c5a1bce7e23f9f47be7b3c7914df08da659db18b6b50c2155

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