1 месяц назад
История
README.md
Каркас
Что такое «Каркас»?
Каркас — это платформа для разработки блочных 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
— блок для создания отчётов об ошибках.
Конвейеры
7 успешных
3 с ошибкой