Metadata-Version: 2.4
Name: digitalai-release-api-client
Version: 26.3.0b5
Summary: Digital.ai Release API Client
Project-URL: Homepage, https://digital.ai/
Project-URL: Documentation, https://docs.digital.ai/
Author-email: "Digital.ai" <pypi-devops@digital.ai>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Requires-Dist: pydantic>=2.0.0
Requires-Dist: requests<3.0.0,>=2.32.5
Provides-Extra: dev
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# Digital.ai Release API Client

The **Digital.ai Release API Client** (`digitalai-release-api-client`) is a Python client library for the [Digital.ai Release REST API](https://apidocs.digital.ai/xl-release/26.1.x/rest-docs/). It is the Python 3 equivalent of the public
[Digital.ai Release Jython API](https://apidocs.digital.ai/jython-docs/#!/xl-release/26.1.x).

## Features

- Compatible with classic Jython API for Release.
  - Same imports and domain classes as original Java API
  - Typed request/response models powered by `pydantic`.
  - Uses Java-style **camelCase** method names, etc.
- Authentication options:
  - **Basic** (username/password)
  - **PAT** (personal access token)
- Use the client directly from any Python script to talk to the Release API.

## Installation

```sh
pip install digitalai-release-api-client
```

## Simple example

Build a `ReleaseAPIClient`, then wrap it with the API class you need.

```python
from com.xebialabs.xlrelease.release_api_client import ReleaseAPIClient
from com.xebialabs.xlrelease.api.v1.release_api import ReleaseApi

client = ReleaseAPIClient("http://localhost:5516", "admin", "admin")
release = ReleaseApi(client).getRelease("Applications/Releasexxxxxxxx")
print(release.id, release.title, release.status)
```

## Related Resources

- **[Digital.ai Release API Client Documentation](https://github.com/digital-ai/release-api-client-python/blob/main/docs/README.md)**: 
  API Classes and Models reference for this Python client library.
  
- **[Digital.ai Python SDK Documentation](https://docs.digital.ai/release/docs/how-to/overview-python-sdk)**:   
  Comprehensive guide to using the Python SDK and building custom tasks.

- **[SDK Template Project for integration plugins](https://github.com/digital-ai/release-integration-template-python)**:   
  A starting point for building custom integrations using Digital.ai Release and Python.

- **[Digital.ai Release Python SDK](https://pypi.org/project/digitalai-release-sdk/)**:
  The official SDK package for integrating with Digital.ai Release on Pypi. 


## Changelog

### Version 26.3.0 (Beta)

#### 🚀 Features

- Initial release of the Python API client for Digital.ai Release.
- Full v1 API coverage with **camelCase** method names matching the Jython API.
- Standalone, self-contained package (runtime dependencies: `pydantic` and `requests`).
