Каркас

Что такое «Каркас»?

Каркас — это платформа для разработки модульных Telegram-ботов, которая призвана упростить взаимодействие с чатами. «Каркас» предоставляет возможность расширять функциональность бота с помощью интеграции различных модулей. Код платформы и набор стандартных модулей находятся в этом монорепозитории.

Структура монорепозитория

Монорепозиторий Karkas включает в себя:

Ядро Karkas (src/karkas_core): Основные компоненты платформы, такие как система управления модулями, логирование и утилиты.
Блоки Karkas (src/karkas_blocks): Содержит стандартные и дополнительные модули, которые расширяют функциональность ботов, созданных на платформе «Каркас».
Бот Gnomик (src/gnomik): Пример реализации бота, созданного на основе платформы «Каркас».

Модули

Модули Karkas — это независимые компоненты, которые добавляют функциональность бота.

Структура модуля

Структура модуля представлена здесь.

Стандартные модули

Стандартные модули предоставляют базовые функции для работы бота

Полный перечень стандартных модулей:

admin — модуль модерирования чата;
roles — модуль управления ролями пользователей;
config — модуль управления конфигурацией бота;
database — модуль для работы с базой данных;
fsm_database_storage — модуль для хранения состояний FSM в базе данных;
filters — модуль, предоставляющий фильтры для aiogram;
message_processing — модуль обработки входящих сообщений;
miniapp — модуль для реализации веб-интерфейса бота;
command_helper — модуль для упрощения регистрации команд бота;
info — модуль предоставления информации о пользователях и чатах.

Дополнительные официальные модули

Дополнительные официальные модули созданы командой разработки платформы «Каркас» и предоставляют расширенные возможности для бота:

yandexgpt — модуль для интеграции с нейросетью YandexGPT;
create_report_apps — модуль для создания отчётов об ошибках.

4.1 KiB Raw Blame History Unescape Escape