digitalai-release-api-client 26.3.0b1__tar.gz

digitalai_release_api_client-26.3.0b1/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

digitalai_release_api_client-26.3.0b1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Digital.ai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

digitalai_release_api_client-26.3.0b1/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: digitalai-release-api-client
+Version: 26.3.0b1
+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: digitalai-release-sdk==26.3.0b1
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# digitalai-release-api-client
+
+The **Digital.ai Release API Client** (`digitalai-release-api-client`) is a Python client for the **Digital.ai Release** public API. It is the Python equivalent of the public
+[Digital.ai Release Jython API](https://apidocs.digital.ai/jython-docs/#!/xl-release/26.1.x) —
+the same `com.xebialabs.xlrelease` packages and **camelCase** method names, so existing Release automation scripts port to Python with minimal changes.
+
+## Features
+- Call the full Digital.ai Release v1 API from Python using familiar **camelCase** method names.
+- Connect with **username/password** or **personal access token** authentication.
+- Use the client standalone, or get a pre-configured client inside a Release container task — no URL or credentials needed.
+- Subclass `ApiBaseTask` for lazily created, cached API objects (`releaseApi`, `phaseApi`, `taskApi`, ...).
+- Typed request/response models powered by `pydantic`.
+
+## Installation
+
+```sh
+pip install digitalai-release-api-client
+```
+
+> **Note:** This client depends on [`digitalai-release-sdk`](https://pypi.org/project/digitalai-release-sdk/), which is installed automatically — no separate install required.
+
+## Getting Started
+
+Build a `ReleaseAPIClient`, then wrap it with the API class you need.
+
+### Option 1 — username / password (HTTP basic auth)
+
+```python
+from digitalai.release.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)
+```
+
+### Option 2 — personal access token
+
+```python
+from digitalai.release.release_api_client import ReleaseAPIClient
+from com.xebialabs.xlrelease.api.v1.release_api import ReleaseApi
+
+client = ReleaseAPIClient(
+    "http://localhost:5516",
+    personal_access_token="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+)
+release = ReleaseApi(client).getRelease("Applications/Releasexxxxxxxx")
+print(release.id, release.title, release.status)
+```
+
+### Option 3 — inside a Release container task
+
+When your code runs as a custom task (a subclass of `BaseTask` from the
+integration SDK), call `self.get_release_api_client()` to get a client already
+configured from the task's "Run as user" context — no URL or credentials needed:
+
+```python
+from digitalai.release.integration.base_task import BaseTask
+from com.xebialabs.xlrelease.api.v1.release_api import ReleaseApi
+
+
+class MyTask(BaseTask):
+    def execute(self) -> None:
+        client = self.get_release_api_client()
+        release = ReleaseApi(client).getRelease("Applications/Releasexxxxxxxx")
+        print(release.id, release.title, release.status)
+```
+
+### Option 4 — subclass `ApiBaseTask` instead of `BaseTask`
+
+To skip the boilerplate, subclass `ApiBaseTask`. It exposes every v1 API as a
+lazily created property (`releaseApi`, `phaseApi`, `taskApi`, ... — one per API
+class), all sharing a single client built from the task's "Run as user" context.
+The client and each API object are created on first access and cached for the
+life of the task (call `self.reset_api_clients()` to force a rebuild):
+
+```python
+from com.xebialabs.xlrelease.api.v1.api_base_task import ApiBaseTask
+
+
+class MyTask(ApiBaseTask):
+    def execute(self) -> None:
+        release = self.releaseApi.getRelease("Applications/Releasexxxxxxxx")
+        print(release.id, release.title, release.status)
+```
+
+## 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.
+- `ApiBaseTask` base class exposing lazily created, cached API objects.
+
+---
+
+## 🔗 Related Resources
+
+- 🧪 **Python Template Project**: [release-integration-template-python](https://github.com/digital-ai/release-integration-template-python)
+  A starting point for building custom integrations using Digital.ai Release and Python.
+
+- 📘 **Official Documentation**: [Digital.ai Release Python SDK Docs](https://docs.digital.ai/release/docs/category/python-sdk)
+  Comprehensive guide to using the Python SDK and building custom tasks.
+
+- 📦 **Digital.ai Release Python SDK**: [digitalai-release-sdk on PyPI](https://pypi.org/project/digitalai-release-sdk/)
+  The official SDK package for integrating with Digital.ai Release.
+
+## License
+
+Licensed under the [MIT License](https://opensource.org/licenses/MIT).

digitalai_release_api_client-26.3.0b1/README.md

@@ -0,0 +1,112 @@
+# digitalai-release-api-client
+
+The **Digital.ai Release API Client** (`digitalai-release-api-client`) is a Python client for the **Digital.ai Release** public API. It is the Python equivalent of the public
+[Digital.ai Release Jython API](https://apidocs.digital.ai/jython-docs/#!/xl-release/26.1.x) —
+the same `com.xebialabs.xlrelease` packages and **camelCase** method names, so existing Release automation scripts port to Python with minimal changes.
+
+## Features
+- Call the full Digital.ai Release v1 API from Python using familiar **camelCase** method names.
+- Connect with **username/password** or **personal access token** authentication.
+- Use the client standalone, or get a pre-configured client inside a Release container task — no URL or credentials needed.
+- Subclass `ApiBaseTask` for lazily created, cached API objects (`releaseApi`, `phaseApi`, `taskApi`, ...).
+- Typed request/response models powered by `pydantic`.
+
+## Installation
+
+```sh
+pip install digitalai-release-api-client
+```
+
+> **Note:** This client depends on [`digitalai-release-sdk`](https://pypi.org/project/digitalai-release-sdk/), which is installed automatically — no separate install required.
+
+## Getting Started
+
+Build a `ReleaseAPIClient`, then wrap it with the API class you need.
+
+### Option 1 — username / password (HTTP basic auth)
+
+```python
+from digitalai.release.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)
+```
+
+### Option 2 — personal access token
+
+```python
+from digitalai.release.release_api_client import ReleaseAPIClient
+from com.xebialabs.xlrelease.api.v1.release_api import ReleaseApi
+
+client = ReleaseAPIClient(
+    "http://localhost:5516",
+    personal_access_token="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+)
+release = ReleaseApi(client).getRelease("Applications/Releasexxxxxxxx")
+print(release.id, release.title, release.status)
+```
+
+### Option 3 — inside a Release container task
+
+When your code runs as a custom task (a subclass of `BaseTask` from the
+integration SDK), call `self.get_release_api_client()` to get a client already
+configured from the task's "Run as user" context — no URL or credentials needed:
+
+```python
+from digitalai.release.integration.base_task import BaseTask
+from com.xebialabs.xlrelease.api.v1.release_api import ReleaseApi
+
+
+class MyTask(BaseTask):
+    def execute(self) -> None:
+        client = self.get_release_api_client()
+        release = ReleaseApi(client).getRelease("Applications/Releasexxxxxxxx")
+        print(release.id, release.title, release.status)
+```
+
+### Option 4 — subclass `ApiBaseTask` instead of `BaseTask`
+
+To skip the boilerplate, subclass `ApiBaseTask`. It exposes every v1 API as a
+lazily created property (`releaseApi`, `phaseApi`, `taskApi`, ... — one per API
+class), all sharing a single client built from the task's "Run as user" context.
+The client and each API object are created on first access and cached for the
+life of the task (call `self.reset_api_clients()` to force a rebuild):
+
+```python
+from com.xebialabs.xlrelease.api.v1.api_base_task import ApiBaseTask
+
+
+class MyTask(ApiBaseTask):
+    def execute(self) -> None:
+        release = self.releaseApi.getRelease("Applications/Releasexxxxxxxx")
+        print(release.id, release.title, release.status)
+```
+
+## 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.
+- `ApiBaseTask` base class exposing lazily created, cached API objects.
+
+---
+
+## 🔗 Related Resources
+
+- 🧪 **Python Template Project**: [release-integration-template-python](https://github.com/digital-ai/release-integration-template-python)
+  A starting point for building custom integrations using Digital.ai Release and Python.
+
+- 📘 **Official Documentation**: [Digital.ai Release Python SDK Docs](https://docs.digital.ai/release/docs/category/python-sdk)
+  Comprehensive guide to using the Python SDK and building custom tasks.
+
+- 📦 **Digital.ai Release Python SDK**: [digitalai-release-sdk on PyPI](https://pypi.org/project/digitalai-release-sdk/)
+  The official SDK package for integrating with Digital.ai Release.
+
+## License
+
+Licensed under the [MIT License](https://opensource.org/licenses/MIT).

digitalai_release_api_client-26.3.0b1/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "digitalai-release-api-client"
+version = "26.3.0b1"
+description = "Digital.ai Release API Client"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Digital.ai", email = "pypi-devops@digital.ai" }]
+requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent"
+]
+dependencies = [
+    "pydantic>=2.0.0",
+    "digitalai-release-sdk==26.3.0b1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+]
+
+[project.urls]
+Homepage = "https://digital.ai/"
+Documentation = "https://docs.digital.ai/"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+# Files never shipped in any build artifact
+[tool.hatch.build]
+exclude = [
+    "**/__pycache__",
+    "**/*.py[cod]",
+    ".coverage",
+    ".mypy_cache",
+    ".pytest_cache",
+    ".ruff_cache",
+    "tests",
+    "docs",
+    "DEVELOPMENT.md",
+]
+
+# Wheel ships only the com.xebialabs.xlrelease package tree
+[tool.hatch.build.targets.wheel]
+packages = ["src/com"]
+
+# Source distribution: package code + project metadata only (no tests)
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/README.md",
+    "/pyproject.toml",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

digitalai_release_api_client-26.3.0b1/src/com/xebialabs/xlrelease/api/v1/__init__.py

@@ -0,0 +1,63 @@
+from com.xebialabs.xlrelease.api.v1.activity_logs_api import ActivityLogsApi
+from com.xebialabs.xlrelease.api.v1.application_api import ApplicationApi
+from com.xebialabs.xlrelease.api.v1.archive_api import ArchiveApi
+from com.xebialabs.xlrelease.api.v1.attachment_api import AttachmentApi
+from com.xebialabs.xlrelease.api.v1.category_api import CategoryApi
+from com.xebialabs.xlrelease.api.v1.configuration_api import ConfigurationApi
+from com.xebialabs.xlrelease.api.v1.delivery_api import DeliveryApi
+from com.xebialabs.xlrelease.api.v1.delivery_pattern_api import DeliveryPatternApi
+from com.xebialabs.xlrelease.api.v1.dsl_api import DslApi
+from com.xebialabs.xlrelease.api.v1.environment_api import EnvironmentApi
+from com.xebialabs.xlrelease.api.v1.environment_label_api import EnvironmentLabelApi
+from com.xebialabs.xlrelease.api.v1.environment_reservation_api import (
+    EnvironmentReservationApi,
+)
+from com.xebialabs.xlrelease.api.v1.environment_stage_api import EnvironmentStageApi
+from com.xebialabs.xlrelease.api.v1.folder_api import FolderApi
+from com.xebialabs.xlrelease.api.v1.folder_versioning_api import FolderVersioningApi
+from com.xebialabs.xlrelease.api.v1.permissions_api import PermissionsApi
+from com.xebialabs.xlrelease.api.v1.phase_api import PhaseApi
+from com.xebialabs.xlrelease.api.v1.release_api import ReleaseApi
+from com.xebialabs.xlrelease.api.v1.report_api import ReportApi
+from com.xebialabs.xlrelease.api.v1.risk_api import RiskApi
+from com.xebialabs.xlrelease.api.v1.roles_api import RolesApi
+from com.xebialabs.xlrelease.api.v1.search_api import SearchApi
+from com.xebialabs.xlrelease.api.v1.task_api import TaskApi
+from com.xebialabs.xlrelease.api.v1.task_reporting_api import TaskReportingApi
+from com.xebialabs.xlrelease.api.v1.team_api import TeamApi
+from com.xebialabs.xlrelease.api.v1.template_api import TemplateApi
+from com.xebialabs.xlrelease.api.v1.triggers_api import TriggersApi
+from com.xebialabs.xlrelease.api.v1.user_api import UserApi
+from com.xebialabs.xlrelease.api.v1.variable_api import VariableApi
+
+__all__ = [
+    "ActivityLogsApi",
+    "ApplicationApi",
+    "ArchiveApi",
+    "AttachmentApi",
+    "CategoryApi",
+    "ConfigurationApi",
+    "DeliveryApi",
+    "DeliveryPatternApi",
+    "DslApi",
+    "EnvironmentApi",
+    "EnvironmentLabelApi",
+    "EnvironmentReservationApi",
+    "EnvironmentStageApi",
+    "FolderApi",
+    "FolderVersioningApi",
+    "PermissionsApi",
+    "PhaseApi",
+    "ReleaseApi",
+    "ReportApi",
+    "RiskApi",
+    "RolesApi",
+    "SearchApi",
+    "TaskApi",
+    "TaskReportingApi",
+    "TeamApi",
+    "TemplateApi",
+    "TriggersApi",
+    "UserApi",
+    "VariableApi",
+]

digitalai_release_api_client-26.3.0b1/src/com/xebialabs/xlrelease/api/v1/activity_logs_api.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+from digitalai.release.release_api_client import ReleaseAPIClient
+
+from com.xebialabs.xlrelease.domain.activity_log import ActivityLogEntry
+
+
+class ActivityLogsApi:
+    """Operations on activity logs."""
+
+    def __init__(self, api: ReleaseAPIClient):
+        """
+        Initializes the ActivityLogsApi.
+
+        :param api: an instance of ReleaseAPIClient used to make HTTP requests.
+        """
+        self.api = api
+
+    def getActivityLogs(self, containerId: str) -> list[ActivityLogEntry]:
+        """
+        Gets activity logs for a container (Release, Task, Delivery, or Trigger).
+
+        :param containerId: the container identifier.
+        :return: a list of activity log entries.
+        """
+        response = self.api.get(f"/api/v1/activities/{containerId}")
+        return ActivityLogEntry.from_response_to_list(response)