Home - FlightDan/dispatcher-sdk GitHub Wiki

Dispatcher SDK Wiki

English | įŽ€äŊ“中文

This guide explains how to run tasks in a Python application with durable state, bounded execution, and explicit recovery. It is for SDK users, including Agent application developers. Your application makes business decisions; Dispatcher handles execution and delivery.

Start here

  1. Quick start: install the checkout and run a complete example.
  2. Managed tasks: use the 0.7 Dispatcher API without assembling the Runtime, Orchestrator and Host yourself.
  3. Core concepts: understand Runtime, Run, task and host ownership.
  4. Integration guide: choose a path for functions, scripts or workflows.
  5. Sandbox execution: run remote Linux scripts and understand cleanup and recovery limits.
  6. Storage and local recovery: inspect SQLite, measure contention and activate a local restored copy.
  7. Troubleshooting: diagnose pending work, duplicates and recovery.
  8. Integration engineering principles: prepare durable deployments and evidence that can be reviewed.
  9. Diagnostics and projections: inspect deployment identity, persist events, and check work availability or cancellation.
  10. Execution activity and supervision: read persisted activity, deadlines, child work and optional stall notifications.

Coding agents should start with DocsforAgents. Detailed API contracts are maintained in docs/SDK.md and the public API guide. Some detailed guides are currently in Chinese; both language editions of this Wiki link to the same authoritative files. For reusable rules about versions, evidence, candidate freezing and safe object discovery, see the integration engineering principles.

Version and scope

These pages describe the 0.7.2 checkout, which requires Python 3.10 or later. Read documentation from the same revision as your code. Older releases may lack these entry points. Before opening an existing database, read storage and upgrades.

The core uses the Python standard library and SQLite. OpenSandbox is optional and requires its own dependency and service. Process isolation controls execution of trusted code; it is not a filesystem or network security sandbox.