Перейти к содержанию

API Reference

Документация для программного использования библиотеки.

Основные классы

Класс Описание
WikiSync Основной класс для синхронизации
WikiAPI HTTP-клиент для Yandex Wiki API
Settings Конфигурация приложения

Модели данных

Модель Описание
FileStatus Статус синхронизации файла
SyncResult Результат операции синхронизации
PageInfo Информация о странице Wiki

Исключения

Исключение Описание
WikiSyncError Базовое исключение
ApiError Ошибка API
ConfigError Ошибка конфигурации
ConflictError Конфликт версий

Пример

from sandboxer.wiki_sync import WikiSync, Settings, WikiSyncError

try:
    settings = Settings.from_file()
    sync = WikiSync(settings)

    for status in sync.get_status():
        if status.status == "modified":
            sync.push_file(status.path)

except WikiSyncError as e:
    print(f"Ошибка: {e.message}")