ocab/README.md

OCAB - Open Chat Ai Bot

Что такое OCAB?

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

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

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

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

Модули

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

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

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

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

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

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

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

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

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