Quick Start

The Istari Digital Platform does not expose a public API. Instead, the supported way to programmatically interact with the platform is through the official Istari Digital Client, available for Python.

Requirements

The SDK is shipped as the istari-digital-client package on PyPI. Supported Python versions for the client are listed on the PyPI project description.

Installation

Install the Python client from PyPI using pip or a tool like uv:

pip install istari-digital-client

Basic Usage

The entry point is the Client object, initialized with a Configuration:

from istari_digital_client import Client, Configuration

config = Configuration(
    registry_url="https://your-instance.istari.digital",
    registry_auth_token="your-personal-access-token",
)

client = Client(config)

• Registry URL: Found under Settings > Developer Settings in the Istari Digital Platform.
• Registry Auth Token: See Personal Access Tokens.

tip

Configuration automatically reads ISTARI_REGISTRY_URL and ISTARI_PERSONAL_ACCESS_TOKEN from the environment (the same names as Settings → Developer Settings in the Istari Digital Platform), so you can omit the constructor arguments when those are set. For compatibility, ISTARI_REGISTRY_AUTH_TOKEN is also accepted for the personal access token value.