lp-agent-runtime-sdk 0.1.0__tar.gz

lp_agent_runtime_sdk-0.1.0/LICENSE

@@ -0,0 +1,182 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of submitting and
+      discussing improvements to the Work, but excluding communication that is
+      conspicuously marked or designated in writing by the copyright owner as
+      "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any Contribution
+      embodied within the Work constitutes direct or contributory patent
+      infringement, then any patent licenses granted to You under this License
+      for that Work shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Contribution, either on an inclusive or exclusive basis.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Liability. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may offer such obligations only on
+      Your own behalf and on Your sole responsibility, not on behalf of
+      any other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Levelplane AI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

lp_agent_runtime_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,203 @@
+Metadata-Version: 2.4
+Name: lp-agent-runtime-sdk
+Version: 0.1.0
+Summary: Python SDK for agent-runtime — invoke declarative agent workflows from Python
+Author-email: Aditya Vinodh Arjun <aditya.vinodh@levelplane.ai>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/levelplaneai/agent-runtime-python
+Project-URL: Repository, https://github.com/levelplaneai/agent-runtime-python
+Project-URL: Issues, https://github.com/levelplaneai/agent-runtime-python/issues
+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: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# lp-agent-runtime-sdk
+
+Python SDK for running [agent-runtime](https://github.com/levelplaneai/agent-runtime) workflows. Wraps the agent-runtime binary to execute declarative `.agent` bundles from Python, with support for registering Python functions as callable tools.
+
+## Installation
+
+```bash
+pip install lp-agent-runtime-sdk
+# or
+uv add lp-agent-runtime-sdk
+```
+
+The package ships pre-built binaries for macOS (arm64, amd64), Linux (amd64, arm64), and Windows (amd64) — no separate install required.
+
+## Quick Start
+
+```python
+from agent_runtime import Runtime, RunError
+
+rt = Runtime()
+
+@rt.tool("pricing.get_quote", version="v1")
+def get_quote(sku: str, quantity: int) -> dict:
+    return {"unit_price": 9.99, "currency": "USD"}
+
+try:
+    output = rt.run("./my_bundle.agent", inputs={"sku": "ABC-1", "quantity": 10})
+    print(output)
+except RunError as e:
+    print(f"Flow failed: {e} (run_id={e.run_id})")
+```
+
+## Authoring Bundles
+
+Bundles are directories with a `.agent` extension containing a declarative flow definition. See [FLOWS.md](https://github.com/levelplaneai/agent-runtime/blob/main/FLOWS.md) in the main repo for the full authoring guide.
+
+## API Reference
+
+### `Runtime(binary=None, env=None)`
+
+Creates a runtime instance.
+
+- `binary` — explicit path to the `agent-runtime` binary (optional)
+- `env` — extra environment variables merged into the subprocess environment
+
+### `@rt.tool(name, version="v1")`
+
+Decorator that registers a Python function as a tool callable by the workflow. The tool reference inside the bundle must match `name@version`.
+
+```python
+@rt.tool("supplier_api.get_price", version="v1")
+def get_price(item_code: str) -> dict:
+    return {"price": 42.0}
+
+# Async tools are also supported
+@rt.tool("data.fetch_record", version="v1")
+async def fetch_record(record_id: str) -> dict:
+    ...
+```
+
+### `rt.run(bundle, inputs=None, on_event=None) -> dict`
+
+Executes a bundle synchronously and returns the flow output as a dict.
+
+### `rt.arun(bundle, inputs=None, on_event=None) -> dict`
+
+Async version of `run`. Use with `await` inside an async context.
+
+```python
+result = await rt.arun("./bundle.agent", inputs={"query": "hello"})
+```
+
+### `rt.validate(bundle)`
+
+Validates a bundle directory. Raises `RuntimeError` if the bundle is invalid.
+
+## File Inputs
+
+Use `FileInput` to pass a local file as a flow input. The path is resolved to an absolute path automatically.
+
+```python
+from agent_runtime import Runtime, FileInput
+
+rt = Runtime()
+output = rt.run("./ocr_bundle.agent", inputs={"document": FileInput("./invoice.pdf")})
+```
+
+## Streaming Events
+
+Pass an `on_event` callback to receive `TraceEvent` objects as the workflow executes.
+
+```python
+def on_event(event: TraceEvent) -> None:
+    print(f"[{event.event}] node={event.node} duration={event.duration_ms}ms")
+
+rt.run("./bundle.agent", inputs={...}, on_event=on_event)
+```
+
+Key `TraceEvent` fields:
+
+| Field | Type | Description |
+|---|---|---|
+| `event` | `str` | Event type (e.g. `node.start`, `node.done`, `tool.call`) |
+| `node` | `str` | Node name in the flow |
+| `node_type` | `str` | Node type (e.g. `llm`, `tool`, `router`) |
+| `tool` | `str` | Tool reference if a tool was called |
+| `model` | `str` | Model name for LLM nodes |
+| `input_tokens` | `int` | Tokens consumed |
+| `output_tokens` | `int` | Tokens produced |
+| `duration_ms` | `int` | Node execution time |
+| `error` | `str` | Error message if the node failed |
+| `output` | `dict` | Node output |
+
+## Traces & Debugging
+
+### Where traces go
+
+Trace events are emitted by the runtime binary to stdout as newline-delimited JSON and streamed to you in real time via the `on_event` callback. There is no separate log file — if you don't attach a callback, events are silently consumed and discarded.
+
+To capture a full trace for debugging, collect all events into a list:
+
+```python
+from agent_runtime import Runtime, TraceEvent, RunError
+
+rt = Runtime()
+trace: list[TraceEvent] = []
+
+try:
+    output = rt.run("./bundle.agent", inputs={...}, on_event=trace.append)
+except RunError as e:
+    # Flow-level failure — the error message and run_id are on the exception.
+    # Check the trace for the node that produced the error.
+    failed = [ev for ev in trace if ev.error]
+    for ev in failed:
+        print(f"node={ev.node} error={ev.error}")
+    raise
+```
+
+### Event types
+
+| Event | When it fires |
+|---|---|
+| `flow_start` | Flow begins executing |
+| `flow_done` | Flow completed successfully |
+| `node_start` | A node begins executing |
+| `node_done` | A node finished (check `ev.error` for failure) |
+| `tool_call` | The runtime is calling a registered tool |
+| `tool_done` | Tool call returned |
+
+### Error channels
+
+There are two ways a run can surface an error:
+
+**Node-level** — a node fails but the flow may continue (e.g. a retry). Delivered as a `TraceEvent` with `event="node_done"` and a non-empty `error` field. The `attempt` and `max_retries` fields indicate retry state.
+
+**Flow-level** — the flow terminates in an error state. The SDK raises `RunError` with the message and `run_id`. Check the collected trace to find which node caused it.
+
+**Binary crash** — the `agent-runtime` process exits with a non-zero code (misconfigured bundle, missing env var, etc.). The SDK raises `RuntimeError` with the stderr output as the message. This is distinct from a flow error and does not produce a `RunError`.
+
+### Typical debug loop
+
+1. Collect the full trace with `on_event=trace.append`
+2. On `RunError`, filter `[ev for ev in trace if ev.error]` to find the failing node
+3. Inspect `ev.inputs`, `ev.args`, and `ev.output` on surrounding events to understand the data at that point
+4. Fix the bundle or tool, then re-run
+
+## Binary Resolution
+
+The SDK locates the `agent-runtime` binary in this order:
+
+1. `binary` argument passed to `Runtime()`
+2. `AGENT_RUNTIME_BIN` environment variable
+3. Bundled platform binary (included in the package)
+4. `agent-runtime` on `PATH`
+
+## Development
+
+```bash
+uv run pytest          # run tests
+uv run ruff check .    # lint
+```

lp_agent_runtime_sdk-0.1.0/README.md

@@ -0,0 +1,181 @@
+# lp-agent-runtime-sdk
+
+Python SDK for running [agent-runtime](https://github.com/levelplaneai/agent-runtime) workflows. Wraps the agent-runtime binary to execute declarative `.agent` bundles from Python, with support for registering Python functions as callable tools.
+
+## Installation
+
+```bash
+pip install lp-agent-runtime-sdk
+# or
+uv add lp-agent-runtime-sdk
+```
+
+The package ships pre-built binaries for macOS (arm64, amd64), Linux (amd64, arm64), and Windows (amd64) — no separate install required.
+
+## Quick Start
+
+```python
+from agent_runtime import Runtime, RunError
+
+rt = Runtime()
+
+@rt.tool("pricing.get_quote", version="v1")
+def get_quote(sku: str, quantity: int) -> dict:
+    return {"unit_price": 9.99, "currency": "USD"}
+
+try:
+    output = rt.run("./my_bundle.agent", inputs={"sku": "ABC-1", "quantity": 10})
+    print(output)
+except RunError as e:
+    print(f"Flow failed: {e} (run_id={e.run_id})")
+```
+
+## Authoring Bundles
+
+Bundles are directories with a `.agent` extension containing a declarative flow definition. See [FLOWS.md](https://github.com/levelplaneai/agent-runtime/blob/main/FLOWS.md) in the main repo for the full authoring guide.
+
+## API Reference
+
+### `Runtime(binary=None, env=None)`
+
+Creates a runtime instance.
+
+- `binary` — explicit path to the `agent-runtime` binary (optional)
+- `env` — extra environment variables merged into the subprocess environment
+
+### `@rt.tool(name, version="v1")`
+
+Decorator that registers a Python function as a tool callable by the workflow. The tool reference inside the bundle must match `name@version`.
+
+```python
+@rt.tool("supplier_api.get_price", version="v1")
+def get_price(item_code: str) -> dict:
+    return {"price": 42.0}
+
+# Async tools are also supported
+@rt.tool("data.fetch_record", version="v1")
+async def fetch_record(record_id: str) -> dict:
+    ...
+```
+
+### `rt.run(bundle, inputs=None, on_event=None) -> dict`
+
+Executes a bundle synchronously and returns the flow output as a dict.
+
+### `rt.arun(bundle, inputs=None, on_event=None) -> dict`
+
+Async version of `run`. Use with `await` inside an async context.
+
+```python
+result = await rt.arun("./bundle.agent", inputs={"query": "hello"})
+```
+
+### `rt.validate(bundle)`
+
+Validates a bundle directory. Raises `RuntimeError` if the bundle is invalid.
+
+## File Inputs
+
+Use `FileInput` to pass a local file as a flow input. The path is resolved to an absolute path automatically.
+
+```python
+from agent_runtime import Runtime, FileInput
+
+rt = Runtime()
+output = rt.run("./ocr_bundle.agent", inputs={"document": FileInput("./invoice.pdf")})
+```
+
+## Streaming Events
+
+Pass an `on_event` callback to receive `TraceEvent` objects as the workflow executes.
+
+```python
+def on_event(event: TraceEvent) -> None:
+    print(f"[{event.event}] node={event.node} duration={event.duration_ms}ms")
+
+rt.run("./bundle.agent", inputs={...}, on_event=on_event)
+```
+
+Key `TraceEvent` fields:
+
+| Field | Type | Description |
+|---|---|---|
+| `event` | `str` | Event type (e.g. `node.start`, `node.done`, `tool.call`) |
+| `node` | `str` | Node name in the flow |
+| `node_type` | `str` | Node type (e.g. `llm`, `tool`, `router`) |
+| `tool` | `str` | Tool reference if a tool was called |
+| `model` | `str` | Model name for LLM nodes |
+| `input_tokens` | `int` | Tokens consumed |
+| `output_tokens` | `int` | Tokens produced |
+| `duration_ms` | `int` | Node execution time |
+| `error` | `str` | Error message if the node failed |
+| `output` | `dict` | Node output |
+
+## Traces & Debugging
+
+### Where traces go
+
+Trace events are emitted by the runtime binary to stdout as newline-delimited JSON and streamed to you in real time via the `on_event` callback. There is no separate log file — if you don't attach a callback, events are silently consumed and discarded.
+
+To capture a full trace for debugging, collect all events into a list:
+
+```python
+from agent_runtime import Runtime, TraceEvent, RunError
+
+rt = Runtime()
+trace: list[TraceEvent] = []
+
+try:
+    output = rt.run("./bundle.agent", inputs={...}, on_event=trace.append)
+except RunError as e:
+    # Flow-level failure — the error message and run_id are on the exception.
+    # Check the trace for the node that produced the error.
+    failed = [ev for ev in trace if ev.error]
+    for ev in failed:
+        print(f"node={ev.node} error={ev.error}")
+    raise
+```
+
+### Event types
+
+| Event | When it fires |
+|---|---|
+| `flow_start` | Flow begins executing |
+| `flow_done` | Flow completed successfully |
+| `node_start` | A node begins executing |
+| `node_done` | A node finished (check `ev.error` for failure) |
+| `tool_call` | The runtime is calling a registered tool |
+| `tool_done` | Tool call returned |
+
+### Error channels
+
+There are two ways a run can surface an error:
+
+**Node-level** — a node fails but the flow may continue (e.g. a retry). Delivered as a `TraceEvent` with `event="node_done"` and a non-empty `error` field. The `attempt` and `max_retries` fields indicate retry state.
+
+**Flow-level** — the flow terminates in an error state. The SDK raises `RunError` with the message and `run_id`. Check the collected trace to find which node caused it.
+
+**Binary crash** — the `agent-runtime` process exits with a non-zero code (misconfigured bundle, missing env var, etc.). The SDK raises `RuntimeError` with the stderr output as the message. This is distinct from a flow error and does not produce a `RunError`.
+
+### Typical debug loop
+
+1. Collect the full trace with `on_event=trace.append`
+2. On `RunError`, filter `[ev for ev in trace if ev.error]` to find the failing node
+3. Inspect `ev.inputs`, `ev.args`, and `ev.output` on surrounding events to understand the data at that point
+4. Fix the bundle or tool, then re-run
+
+## Binary Resolution
+
+The SDK locates the `agent-runtime` binary in this order:
+
+1. `binary` argument passed to `Runtime()`
+2. `AGENT_RUNTIME_BIN` environment variable
+3. Bundled platform binary (included in the package)
+4. `agent-runtime` on `PATH`
+
+## Development
+
+```bash
+uv run pytest          # run tests
+uv run ruff check .    # lint
+```

lp_agent_runtime_sdk-0.1.0/agent_runtime/__init__.py

@@ -0,0 +1,4 @@
+from ._runtime import Runtime
+from ._types import FileInput, MissingAPIKeyError, RunError, TraceEvent
+
+__all__ = ["Runtime", "FileInput", "MissingAPIKeyError", "RunError", "TraceEvent"]