Go to file
2024-08-16 22:45:30 +03:00
docs Переименование проекта c OCAB в Karkas 2024-08-16 22:42:02 +03:00
scripts Переименование проекта c OCAB в Karkas 2024-08-16 22:42:02 +03:00
src Переименование проекта c OCAB в Karkas 2024-08-16 22:42:02 +03:00
.bandit Добавлены инструменты для повышения качества кода 2024-07-07 23:59:33 +03:00
.flake8 Автоматический рефакторинг и игнорирование flake8 2024-07-08 00:38:01 +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 Добавлен bandit в pre-commit-hook 2024-07-08 00:49:04 +03:00
AUTHORS Переименовал файл со списком авторов 2024-08-16 22:40:33 +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
LICENSE Create LICENSE 2023-07-08 20:36:02 +03:00
ocab.code-workspace Переименование проекта c OCAB в Karkas 2024-08-16 22:42: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-16 22:45:30 +03:00

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