Metadata-Version: 2.4
Name: io-openagent-sdk
Version: 0.3.0
Summary: Config-as-code agent SDK
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx[http2]>=0.28.1
Requires-Dist: pydantic>=2.0
Provides-Extra: dev
Requires-Dist: coverage[toml]>=7.6.0; extra == "dev"
Requires-Dist: pytest>=8.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
Requires-Dist: io-openagent-sdk[rich]; extra == "dev"
Provides-Extra: mcp
Requires-Dist: mcp>=1.0.0; extra == "mcp"
Provides-Extra: mem0
Requires-Dist: mem0ai>=1.0.5; extra == "mem0"
Provides-Extra: openai
Requires-Dist: httpx>=0.27.0; extra == "openai"
Requires-Dist: openai>=1.0.0; extra == "openai"
Provides-Extra: otel
Requires-Dist: opentelemetry-api>=1.25.0; extra == "otel"
Provides-Extra: rich
Requires-Dist: rich>=13.7.0; extra == "rich"
Provides-Extra: sqlite
Requires-Dist: aiosqlite>=0.20.0; extra == "sqlite"
Provides-Extra: tokenizers
Requires-Dist: tiktoken>=0.7.0; extra == "tokenizers"
Provides-Extra: yaml
Requires-Dist: pyyaml>=6.0; extra == "yaml"
Provides-Extra: all
Requires-Dist: io-openagent-sdk[dev,mcp,mem0,openai,otel,rich,sqlite,tokenizers,yaml]; extra == "all"
Dynamic: license-file

# OpenAgents SDK

Build protocol-rich agents on top of a small, explicit runtime kernel.

OpenAgents is a config-as-code, async-first SDK for teams that want a clear
single-agent runtime, a small set of strong extension seams, and enough room to
invent product-specific middle protocols above the kernel.

Key public contracts in `0.3.0`:

- `RunContext[DepsT]` for typed local dependency injection
- `RunRequest` / `RunResult[OutputT]` as structured runtime IO
- `Runtime.run_stream()` for event-level streaming projection
- `RunUsage.cost_usd` + `RunBudget.max_cost_usd` for cost tracking / budgeting
- `StopReason` for typed run termination state
- `openagents` CLI: `schema`, `validate`, `list-plugins`

What's new in `0.3.0`: see [CHANGELOG](CHANGELOG.md) and the
[0.2 → 0.3 migration guide](docs/migration-0.2-to-0.3.md).

## Start Here

- [English README](README_EN.md)
- [中文 README](README_CN.md)
- [Developer Docs](docs/README.md)
- [Repository Layout](docs/repository-layout.md)
- [Examples](docs/examples.md)

## Quick Repo Workflow

Sync dependencies:

```bash
uv sync
```

Run the test suite:

```bash
uv run pytest -q
```

Run the smallest maintained example:

```bash
uv run python examples/quickstart/run_demo.py
```

## Maintained Repo Shape

```text
openagents/  SDK source
docs/        developer documentation
examples/    maintained runnable examples
tests/       unit and integration coverage
```

Current maintained examples:

- `examples/quickstart/`
- `examples/production_coding_agent/`
