Skip to content

cataIystdev/catalib

Repository files navigation

catalib

Документация: raito-kyokai.gitbook.io/catalib

Инструмент сборки модульных плагинов для exteraGram.

exteraGram загружает плагин как ровно один файл <plugin_id>.py. catalib позволяет разрабатывать плагин в виде нормального дерева пакетов (папки, подпапки, несколько модулей) и собирать его в один самодостаточный .py, пригодный для штатной установки и распространения. Внутрь собранного файла встраивается компактный загрузчик на основе sys.meta_path, благодаря которому обычные import между модулями плагина работают без изменений, а трейсбеки указывают на исходные файлы.

Состав

  • CLI catalib с командами build, watch, init.
  • Ядро сборки (bundler) и встраиваемый рантайм-загрузчик.
  • Валидация метаданных плагина по правилам exteraGram (статический разбор через AST).
  • Рантайм-хелперы, импортируемые из плагина: безопасные импорты SDK с заглушками для офлайн-тестов, утилиты потоков, хуков и настроек.
  • Деплой на устройство через ADB и перезагрузка плагина.

Требования

  • Python 3.11 и новее (соответствует среде Chaquopy внутри exteraGram).

Установка

pip install catalib

Документация

Полное руководство пользователя опубликовано в GitBook: https://raito-kyokai.gitbook.io/catalib — установка, быстрый старт, руководство, CLI, деплой, внутреннее устройство, примеры, решение проблем, публикация в PyPI и настройка GitBook.

Исходники документации — в каталоге book/ (синхронизируются с GitBook через Git Sync).

Внутренняя проектная документация (архитектура, ADR, планы) — в каталоге docs/.

Автор

catalyst. Плагины и новости — Telegram-канал @catalystdevplugins.

Лицензия

MIT. См. файл LICENSE.

About

Инструмент сборки модульных плагинов для exteraGram. exteraGram загружает плагин как ровно один файл `<plugin_id>.py`. catalib позволяет разрабатывать плагин в виде нормального дерева пакетов (папки, подпапки, несколько модулей) и собирать его в один самодостаточный `.py`, пригодный для штатной установки и распространения.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors