Skip to main content

Python SDK for the Rigby API (parity with the TypeScript SDK).

Project description

RigbySDK Python

Официальный Python SDK для работы с Rigby API. Структура и методы соответствуют TypeScript SDK (@rigbyhost/sdk-ts), так что переносить код просто.

Установка

pip install rigbysdk
# или локально из репозитория
pip install -e .

Быстрый старт

from rigbysdk import RigbySDK

sdk = RigbySDK("YOUR_API_TOKEN")

# Получить конфиг сервера
config = sdk.gdps.config.get({"srvId": "my-server-id"})

# Обновить сундуки
sdk.gdps.config.updateChests({
    "srvId": "my-server-id",
    "chestConfig": {
        "ChestSmallOrbsMin": 50,
        "ChestSmallOrbsMax": 100,
        "ChestSmallDiamondsMin": 2,
        "ChestSmallDiamondsMax": 5,
        "ChestSmallShards": [1, 2, 3, 4, 5, 6],
        "ChestSmallKeysMin": 1,
        "ChestSmallKeysMax": 3,
        "ChestSmallWait": 3600,
        "ChestBigOrbsMin": 200,
        "ChestBigOrbsMax": 400,
        "ChestBigDiamondsMin": 20,
        "ChestBigDiamondsMax": 50,
        "ChestBigShards": [1, 2, 3, 4, 5, 6],
        "ChestBigKeysMin": 1,
        "ChestBigKeysMax": 3,
        "ChestBigWait": 14400
    }
})

# Поиск уровней
levels = sdk.gdps.levels.search({
    "srvId": "my-server-id",
    "query": "demon",
})

# Текущий пользователь
me = sdk.user.me()

API

  • Поля и аргументы методов повторяют формы из TS SDK (Zod схемы). Передавайте те же ключи/значения.
  • Методы сгруппированы так же, как в TS: sdk.gdps.*, sdk.notifications.*, sdk.user.*, включая вложенные player.songs, gdps.server, и т.д.

Обработка ошибок

При ошибках HTTP или некорректном ответе выбрасывается RigbySDKError. Сообщение содержит статус и текст ответа (если доступно).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rigbysdk-0.1.0.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rigbysdk-0.1.0-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file rigbysdk-0.1.0.tar.gz.

File metadata

  • Download URL: rigbysdk-0.1.0.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rigbysdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cfcef223dc922db106785d727ecc255210c228d293bab5c52312e3083496fb69
MD5 73769b1b3a4c99eb48fcc6eeb88124c3
BLAKE2b-256 4e560ddb00f7ceb0a576fd7fc97e4fe5d215d0643161f138c2affff0b8be7fbf

See more details on using hashes here.

File details

Details for the file rigbysdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: rigbysdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rigbysdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f39e8496b04dd58b4c5b4ad031e8515cfdee1d3ad30f3f47cf2dd8d3941cdd5d
MD5 761870d1fd15bc20edea0f7bbe0ea2a8
BLAKE2b-256 cbaed941005fc17f089b398d8a774d13bce1b9d91a6f053c6de3249fe49f335f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page