Skip to content

Commit eddc7f1

Browse files
author
Kowser
committed
Add agents documentation; update README with extras install instructions
Copies Agentspan's docs/ (6 files: README, getting-started, writing-agents, advanced, framework-agents, api-reference) into docs/agents/. Fixes the two install-instruction lines that referenced the now-discarded package: docs/agents/README.md's PyPI badge and docs/agents/getting-started.md's `uv add conductor-agent-sdk` -- both now point at `pip install 'conductor-python[agents]'`. Left CLI command references (`agentspan deploy`, `agentspan credentials set`, etc.) untouched -- those describe the separate Go CLI binary, which is its own release artifact in the agentspan monorepo, not part of this merge or the Agentspan Python SDK being discarded. Adds a new "AI Agents" section to the root README (deliberately separate from the existing "AI & LLM Workflows" section, which covers the older conductor.client.ai orchestrator layer, not this durable agent-runtime layer) plus a docs-table entry and an extras-install callout in "Install the SDK". Mirrors the same addition in examples/README.md's AI/LLM Workflows area, pointing at the new examples/agents/README.md catalog rather than duplicating its 270+ entries.
1 parent 1862c71 commit eddc7f1

8 files changed

Lines changed: 1428 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ If you find [Conductor](https://github.com/conductor-oss/conductor) useful, plea
2323
* [Monitoring with Metrics](#monitoring-with-metrics)
2424
* [Managing Workflow Executions](#managing-workflow-executions)
2525
* [AI & LLM Workflows](#ai--llm-workflows)
26+
* [AI Agents](#ai-agents)
2627
* [Why Conductor?](#why-conductor)
2728
* [Examples](#examples)
2829
* [Documentation](#documentation)
@@ -67,6 +68,13 @@ pip install conductor-python
6768

6869
> **Already in a virtual environment?** Skip the `venv` step and run `pip install conductor-python` directly. On macOS, Windows, or in containers where system Python is not locked down, you can also install globally.
6970
71+
Building durable AI agents instead? Install the `agents` extra (or a per-framework extra —
72+
see [AI Agents](#ai-agents)):
73+
74+
```shell
75+
pip install 'conductor-python[agents]'
76+
```
77+
7078
## 60-Second Quickstart
7179

7280
**Step 1: Create a workflow**
@@ -407,6 +415,35 @@ python examples/rag_workflow.py document.pdf "What are the key findings?"
407415
408416
---
409417
418+
## AI Agents
419+
420+
Beyond the workflow-embedded LLM calls above, `conductor-python` also ships a durable
421+
agent-authoring layer — `Agent`, `AgentRuntime`, `tool`, guardrails, handoffs, and multi-agent
422+
strategies — where the agent itself compiles into a Conductor workflow that runs on the server,
423+
with retries, durable state, streaming, and human-in-the-loop pauses built in.
424+
425+
```shell
426+
pip install 'conductor-python[agents]'
427+
```
428+
429+
```python
430+
from conductor.ai.agents import Agent, AgentRuntime
431+
432+
agent = Agent(name="greeter", model="anthropic/claude-sonnet-4-6",
433+
instructions="You are a friendly assistant.")
434+
435+
with AgentRuntime() as runtime:
436+
result = runtime.run(agent, "Say hello.")
437+
print(result.output)
438+
```
439+
440+
Framework integrations (LangChain, LangGraph, Google ADK, the OpenAI Agents SDK, Claude Agent SDK)
441+
are optional extras — see [docs/agents/getting-started.md](docs/agents/getting-started.md) for
442+
per-framework install instructions, and [examples/agents/](examples/agents/) for 270+ runnable
443+
examples. Full docs: [docs/agents/](docs/agents/).
444+
445+
---
446+
410447
## Why Conductor?
411448
412449
| | |
@@ -467,6 +504,7 @@ End-to-end examples covering all APIs for each domain:
467504
| [Secrets](docs/SECRET_MANAGEMENT.md) | Secret storage |
468505
| [Prompts](docs/PROMPT.md) | AI/LLM prompt templates |
469506
| [Integrations](docs/INTEGRATION.md) | AI/LLM provider integrations |
507+
| [AI Agents](docs/agents/README.md) | Durable agent authoring: `Agent`, `AgentRuntime`, tools, guardrails, handoffs |
470508
| [Metrics](METRICS.md) | Prometheus metrics collection |
471509
| [Examples](examples/README.md) | Complete examples catalog |
472510

docs/agents/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Agentspan Python SDK
2+
3+
> Ships as part of [`conductor-python`](https://pypi.org/project/conductor-python/) — install with the `agents` extra
4+
> (`pip install 'conductor-python[agents]'`) — you're in the right place.
5+
6+
Long-running, dynamic plan-execute, and event-driven AI agents in Python. You write plain Python; Agentspan compiles your agent into a Conductor workflow that runs on a server — with automatic retries, durable state, human-in-the-loop pauses, streaming, scheduling, dynamic plan-execute, and full execution history.
7+
8+
```python
9+
from conductor.ai.agents import Agent, AgentRuntime
10+
11+
agent = Agent(name="greeter", model="anthropic/claude-sonnet-4-6",
12+
instructions="You are a friendly assistant.")
13+
14+
with AgentRuntime() as runtime:
15+
result = runtime.run(agent, "Say hello.")
16+
print(result.output)
17+
```
18+
19+
## Docs
20+
21+
- [Getting started](getting-started.md) — install, env vars, and a running agent in under 30 seconds.
22+
- [Writing agents](writing-agents.md) — the `Agent` class and `@agent`, tools, multi-agent strategies, handoffs, guardrails, termination, callbacks, streaming + HITL, schedules, stateful and instance agents.
23+
- [Framework agents](framework-agents.md) — run agents authored in the OpenAI Agents SDK, LangChain, LangGraph, or the Claude Agent SDK.
24+
- [Advanced](advanced.md) — runtime config, the control-plane `AgentClient`, deploy vs serve vs run vs plan, structured output, credentials, plans (`PLAN_EXECUTE`), skills.
25+
- [API reference](api-reference.md) — the public API surface in one place.
26+
27+
## Import surface
28+
29+
Everything public is importable from `conductor.ai.agents`:
30+
31+
```python
32+
from conductor.ai.agents import Agent, AgentRuntime, tool, agent
33+
```
34+
35+
A small OpenAI-Agents-compatible shim is also exposed at the top level:
36+
37+
```python
38+
from conductor.ai import Runner, function_tool # drop-in for `agents.Runner`
39+
```

0 commit comments

Comments
 (0)