0
0
mirror of https://gitflic.ru/project/maks1ms/ocab.git synced 2024-12-24 00:33:05 +03:00
Go to file
2024-07-31 20:01:32 +03:00
docs обновил документацию 2024-07-31 20:01:32 +03:00
scripts Merged with private/new-module-system 2024-07-14 17:07:46 +03:00
src обновил документацию 2024-07-31 20:01:32 +03:00
.bandit Добавлены инструменты для повышения качества кода 2024-07-07 23:59:33 +03:00
.flake8 Автоматический рефакторинг и игнорирование flake8 2024-07-08 00:38:01 +03:00
.gitignore исправлено сохранение настроек 2024-07-31 15:20:13 +03:00
.mailmap Добавлен .mailmap 2024-07-17 19:37:48 +03:00
.pre-commit-config.yaml Добавлен bandit в pre-commit-hook 2024-07-08 00:49:04 +03:00
LICENSE Create LICENSE 2023-07-08 20:36:02 +03:00
ocab.code-workspace добавлен workspace 2024-07-31 17:03:50 +03:00
poetry.lock подготовка к публикации 2024-07-28 18:48:25 +03:00
poetry.toml исправлено сохранение настроек 2024-07-31 15:20:13 +03:00
pyproject.toml подготовка к публикации 2024-07-28 18:48:25 +03:00
README.md обновил документацию 2024-07-31 20:01:32 +03:00

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 - модуль для создания отчетов об ошибках.