Go to file
Давид Султаниязов 50aae16d62 Merged with KarkasLite
2024-08-24 20:41:42 +03:00
docs Рефакторинг файлов README.md и документации 2024-08-24 15:34:13 +03:00
scripts Переименование проекта c OCAB в Karkas 2024-08-16 22:42:02 +03:00
src Рефакторинг файлов README.md и документации 2024-08-24 15:34:13 +03:00
.bandit Добавлены инструменты для повышения качества кода 2024-07-07 23:59:33 +03:00
.flake8 добавляет правило TC200 2024-08-22 12:17:54 +03:00
.gitignore Переименование проекта c OCAB в Karkas 2024-08-16 22:42:02 +03:00
.mailmap Merged with feat/config-module 2024-08-02 16:59:51 +03:00
.pre-commit-config.yaml правит документацию 2024-08-22 11:47:14 +03:00
AUTHORS Рефакторинг файлов README.md и документации 2024-08-24 15:34:13 +03:00
AUTHORS_EN Добавил английскую версию со списком авторов проекта 2024-08-16 22:41:08 +03:00
gitflic-ci.yaml Merged with fix/add-limits-to-report 2024-08-16 16:23:57 +03:00
karkas.code-workspace мелкие правки 2024-08-22 11:49:27 +03:00
LICENSE Create LICENSE 2023-07-08 20:36:02 +03:00
poetry.lock Merged with feat/config-module 2024-08-02 16:59:51 +03:00
poetry.toml Merged with feat/config-module 2024-08-02 16:59:51 +03:00
pyproject.toml Переименование проекта c OCAB в Karkas 2024-08-16 22:42:02 +03:00
README.md Рефакторинг файлов README.md и документации 2024-08-24 15:34:13 +03:00

Каркас

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

Каркас — это платформа для разработки модульных 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 — модуль для создания отчётов об ошибках.