Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Digital.ai Release Python SDK

The Digital.ai Release Python SDK (digitalai-release-sdk) provides a set of tools for developers to create container-based integration with Digital.ai Release. It simplifies integration creation by offering built-in functions to interact with the execution environment.

Features

  • Define custom tasks using the BaseTask abstract class.
  • Subclass ApiBaseTask to access the Release APIs (releaseApi, phaseApi, taskApi, ...) through a ready-to-use client.
  • Easily manage input and output properties.
  • Interact with the Digital.ai Release environment seamlessly.

Installation

Install the SDK using pip:

pip install digitalai-release-sdk

Note: The SDK depends on digitalai-release-api-client, which is installed automatically.

Getting Started

Example Task: hello.py

The following example demonstrates how to create a simple task using the SDK:

from digitalai.release.integration import BaseTask

class Hello(BaseTask):
    
    def execute(self) -> None:
        # Get the name from the input
        name = self.input_properties.get('yourName')
        if not name:
            raise ValueError("The 'yourName' field cannot be empty")

        # Create greeting message
        greeting = f"Hello {name}"

        # Add greeting to the task's comment section in the UI
        self.add_comment(greeting)

        # Store greeting as an output property
        self.set_output_property('greeting', greeting)

Example Task using the Release API: ApiBaseTask

Subclass ApiBaseTask to call the Release v1 REST API without building a client yourself. Every API is exposed as a lazily created, cached property, all sharing a single client built from the task's "Run as user" context:

from digitalai.release.integration.api_base_task import ApiBaseTask


class ShowVersion(ApiBaseTask):

    def execute(self) -> None:
        release = self.releaseApi.getRelease(self.get_release_id())
        self.add_comment(f"Working on {release.title}")

Changelog

Version 27.1.0b1

🚀 Features

  • Tasks can be aborted. On abort, the SDK calls the task's abort() method; long-running tasks can check is_abort_requested() and stop early.
  • After an abort, the SDK waits briefly (ABORT_GRACE_PERIOD_SECONDS, default 3) so the task's outputs and reporting records are still sent.
  • Added the AiUsageRecord reporting record for AI agent runs (model, tokens, cost and more). Requires a Release version that supports udm.AiUsageRecord.

🐛 Fixes

  • The task result is no longer cut off if an abort signal arrives while it is being reported.
  • Aborted tasks no longer report exit code 0; sys.exit(n) now reports exit code n.
  • Tasks that don't call super().__init__() work again.
  • setReleaseVariable(), setFolderVariable() and setGlobalVariable() now accept a list for list variables.

Metadata

Release files for digitalai_release_sdk 27.1.0b1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for digitalai_release_sdk 27.1.0b1
File Size Uploaded Provenance Actions
digitalai_release_sdk-27.1.0b1.tar.gz 24.8 kB Without provenance Details for digitalai_release_sdk-27.1.0b1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for digitalai_release_sdk 27.1.0b1
File Interpreter ABI Platform Actions
digitalai_release_sdk-27.1.0b1-py3-none-any.whl Python 3 none any Details for digitalai_release_sdk-27.1.0b1-py3-none-any.whl

Total release size: 55.2 kB

Release files / digitalai_release_sdk-27.1.0b1.tar.gz

Download URL digitalai_release_sdk-27.1.0b1.tar.gz
Size 24.8 kB
Tags Source
SHA-256 checksum
How to use checksums
14f7fbda4ceed84454b6937050db23096b093de08caba3d9e463bc7073d71004
BLAKE2b-256 checksum
How to use checksums
f3fe774e6ab0b696401375fb078c5bfd4a8663fe9dbdb69ed881c8ada892cee0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.5

Release files / digitalai_release_sdk-27.1.0b1-py3-none-any.whl

Download URL digitalai_release_sdk-27.1.0b1-py3-none-any.whl
Size 30.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
69b3de5e4c2eba0b1a58e829995b8717279119fe54083187defbf7d1d6c637b3
BLAKE2b-256 checksum
How to use checksums
23c5f2c1c584e5688141586ef6c8bde1389099357b2d5454ba751d390595dbce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.5

Security for digitalai_release_sdk 27.1.0b1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page