Karkas

Что такое Karkas?

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

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

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

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

Модули

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

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

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

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

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

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

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

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

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

3.8 KiB Raw Blame History Unescape Escape