Skip to main content
Version: 2026.08

Setup

The istari-digital-client package on PyPI is the official Python interface to the Istari Digital Platform. This page covers installing the package and creating a configured Client instance — the entry point used by every other example in this section.

For a first System from a bare machine, work through Python Client 201 — Your first System (istari_quickstart.py) instead of assembling these calls yourself.

istari-digital-client 13.x also ships an Istari facade (from istari_digital_client.sdk import Istari) — a shorter surface for Resources, Systems, and Jobs. It is marked beta in the package (the surface may change). Production examples in this section stay on Client / V3Client. Folder layout still needs Client (NewTrackedFile(folder_path=…)); see Folders in the Python client. Agent recipes for 13.x are installed from Start with Claude Code.

Requirements​

Supported Python versions are listed on the PyPI project description.

Installation​

Install the package using pip or a tool like uv:

pip install istari-digital-client

Key authentication signs a JWT. The client declares cryptography and PyJWT as dependencies; they install with the package. If a Key run fails with No module named 'cryptography' (or jwt), install those two into the same environment as the client.

Initialize the client​

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

from istari_digital_client import Client, Configuration

config = Configuration(
    digital_api_url="https://your-instance.istari.digital",
    identity_service_secret_file="/path/to/your/key.json",
    identity_service_enabled=True,
)

client = Client(config)
  • Digital API URL: Found as the API URL in the Endpoints section under Settings > Developer Settings in the Istari Digital Platform.
  • Identity Service Secret File: See Keys.

Identity Service secrets should only be used when the Identity Service is enabled.

PAT configuration​

Deprecated

PATs are deprecated as of the July 2026 release and have been superseded by Keys. Support for PATs will be removed from the platform in a future release.

See the PAT → Key Exchange guide to migrate to keys.

To authenticate with a PAT instead of a key, create the Client as:

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 as the Registry URL in the Endpoints section under Settings > Developer Settings in the Istari Digital Platform.
  • Registry Auth Token: See Personal Access Tokens.
tip

Configuration reads ISTARI_REGISTRY_URL, ISTARI_REGISTRY_AUTH_TOKEN, ISTARI_DIGITAL_API_URL, IDENTITY_SERVICE_SECRET_FILE, and ISTARI_DIGITAL_IDENTITY_SERVICE_ENABLED from environment variables, so you can omit the constructor arguments when those are set.

note

The package also ships a V3Client for the unified resource API. See the v3 Quick Start for details.