allybuild-sdk

Python SDK for AllyBuild — the sandbox-isolated task scheduling and execution platform.

It is the interaction surface available inside AllyBuild task scripts: a pure-stdlib HTTP facade (zero third-party dependencies) covering tasks, agents, memories, OKF, MCP, project status, plus a Vue-Reactive-style state store.

• Homepage: https://allybuild.ai/

Installation

pip install allybuild-sdk

Requires Python >= 3.10. No third-party dependencies.

Usage

Inside an AllyBuild task, your script runs with workflow.py (injected with params / reporter / TASK_JWT / ALLYBUILD_API_URL):

def run(params: dict, reporter) -> None:
    reporter.set_phase("fetch")        # update current phase
    reporter.set_progress(50)          # update progress 0-100

    data = list_tasks(status="success")
    okf_search("runbook", query="deploy")
    return {"count": len(data)}

Import side effects run too (Convention 2) — top-level create_task(...) calls are flushed automatically.

Direct client

from allybuild_sdk import AllyBuildClient, create_client

api = create_client(
    base_url="https://your-host/api",   # ALLYBUILD_API_URL
    token="<TASK_JWT>",
    project_id="<PROJECT_ID>",
)
tasks = api.tasks.list(status="running")
api.reporter.set_progress(20)

Reactive store

A Pinia/Vue-Reactive-style store, in-memory by default, optionally persisted to the AllyBuild backend for cross-task/cross-process sharing:

from allybuild_sdk.reactive import defineStore, getter, action, create_reactive

create_reactive()

@defineStore("counter")
class CounterStore:
    count: int = 0

    @getter
    def display(self) -> str:
        return f"count: {self.count}"

    @action
    def increment(self, by: int = 1) -> None:
        self.count += by

store = CounterStore()
store.increment()
print(store.display)  # "count: 1"

Modules

License

MIT