Skip to main content

Digital.ai Release SDK

Project description

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.
  • Easily manage input and output properties.
  • Interact with the Digital.ai Release environment seamlessly.
  • Simplified API client for efficient communication with Release API.

Installation

Install the SDK using pip:

pip install digitalai-release-sdk

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)

Changelog

Version 26.1.0

🛠️ Enhancements

  • Updated minimum Python version requirement to 3.10.
  • Updated dependency versions to enhance compatibility and security.
  • Added support for the scriptLocation hidden property to explicitly define the task script path, improving performance and file organization.

🔗 Related Resources

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

digitalai_release_sdk-26.1.0.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

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

digitalai_release_sdk-26.1.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file digitalai_release_sdk-26.1.0.tar.gz.

File metadata

  • Download URL: digitalai_release_sdk-26.1.0.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for digitalai_release_sdk-26.1.0.tar.gz
Algorithm Hash digest
SHA256 c7859ccce567b8a95e1a3fd578bb374b97145e97c5d0ae52ee5500edf03ecebd
MD5 da88c9500ffee752e26ca1de2f0e6fde
BLAKE2b-256 680c30aa674ad14e2fa7dd923cac6dde448d37e782c82b1e1f7bb3969177ddfb

See more details on using hashes here.

File details

Details for the file digitalai_release_sdk-26.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for digitalai_release_sdk-26.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 efcfb9f187bf66b8f5031bb6b826f5b4f1b8ed1953e819de4d753a1dc2444ee5
MD5 5048cca04b494314c226932ad7e14f1a
BLAKE2b-256 b9128e4379a5420b128f94af2b91eb6633d33360a71fb778c574531863bb2bcb

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