Cluster · разработчикам

Разработчикам

Здесь собрана документация юзербота Cluster для Telegram: создание модулей на Python, работа с API и устройство ядра. Начни с первого модуля, если хочешь добавить свою команду. Для отдельных методов и параметров используй справочник API.

Статьи в Telegraph

• Cluster: знакомство с проектом, устройство ядра, права и работа модулей.
• Модули Cluster. Разработка и публикация: создание модулей с примерами и пошаговая публикация в каталоге.

Первый модуль

Пошаговые руководства: подключение Telegram, настройка команд и создание первого модуля на Python.

Создание модуля и публикация в каталоге

Два полных примера: команды Ping и Echo, затем счётчик с настройкой, кнопкой и страницей на сайте. В конце описаны сборка архива, публикация, доступ тестерам и выпуск обновлений.

Подробное руководство по разработке объясняет обработчики, данные, файлы, сеть, расписание и ошибки.

Составной модуль: два готовых пакета с кнопками, файлами, HTTPS, расписанием и вызовами зависимости. Примеры предназначены для отдельной тестовой среды.

Справочник

• API модуля: методы, аргументы, результаты и примеры.
• Команды, поля и страницы: описание интерфейса и обработчики.
• Права и ограничения: доступ модуля, овнеры и доверка.
• Telegram и личные боты: сообщения, вложения и подключения.
• Конструкторы Telegram: все типы и методы Bot API и Telethon, клавиатуры, личные формы, файлы и права.
• Публикация в каталоге: версии, зависимости, тестеры, отзывы и обновления.
• Проверка перед выпуском: запуск, ограничения, ошибки и перенос данных.
• Все разделы документации.

Устройство Cluster

Знакомство с проектом описывает назначение Cluster, профиль, юзербот и модули.

Карта процессов показывает обработку команды, установку, обновление, обмен данными и восстановление. У каждого шага есть описание проверок и причин отказа.

Устройство ядра объясняет процессы, изоляцию и хранение данных. HTTP API и список маршрутов нужны для собственного клиента. Порядок установки сервиса находится в развёртывании.

Публикация

Войди в Cluster и открой каталог модулей. Сначала опубликуй непубличную версию и проверь её на своём юзерботе. Для обновления открой свою публикацию и нажми «Управление» → «Добавить версию».

Для чтения документации вход и подписка не нужны.