Skip to content

Commit 11f086f

Browse files
nficanoclaude
andcommitted
docs: update README badges and install section for new package name
PyPI shield and Python-versions shield now point at `agentruntimecontrolprotocol`. Install section documents the new name and the per-extras layout (`[runtime]`, `[otel]`, `[jwks]`, `[all]`, `[test]`) instead of the old single-install line. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 85a68f2 commit 11f086f

1 file changed

Lines changed: 13 additions & 8 deletions

File tree

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<p align="center"><strong>Python SDK for the Agent Runtime Control Protocol (ARCP) — submit, observe, and control long-running agent jobs from Python.</strong></p>
44

55
<p align="center">
6-
<a href="https://pypi.org/project/arcp/"><img alt="PyPI" src="https://img.shields.io/pypi/v/arcp.svg"></a>
7-
<a href="https://pypi.org/project/arcp/"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/arcp.svg"></a>
6+
<a href="https://pypi.org/project/agentruntimecontrolprotocol/"><img alt="PyPI" src="https://img.shields.io/pypi/v/agentruntimecontrolprotocol.svg"></a>
7+
<a href="https://pypi.org/project/agentruntimecontrolprotocol/"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/agentruntimecontrolprotocol.svg"></a>
88
<a href="https://github.com/agentruntimecontrolprotocol/python-sdk/actions/workflows/test.yml"><img alt="CI" src="https://github.com/agentruntimecontrolprotocol/python-sdk/actions/workflows/test.yml/badge.svg"></a>
99
<a href="https://codecov.io/gh/agentruntimecontrolprotocol/python-sdk"><img alt="codecov" src="https://codecov.io/gh/agentruntimecontrolprotocol/python-sdk/graph/badge.svg"></a>
1010
<a href="https://github.com/agentruntimecontrolprotocol/spec/blob/main/docs/draft-arcp-1.1.md"><img alt="ARCP" src="https://img.shields.io/badge/ARCP-v1.1%20draft-blue"></a>
@@ -28,16 +28,21 @@ ARCP itself is a transport-agnostic wire protocol for long-running AI agent jobs
2828

2929
## Installation
3030

31-
Requires Python 3.11 or later. The SDK ships as a single wheel containing the client, runtime, transports, ASGI/aiohttp middleware, the OpenTelemetry middleware, and the `arcp` CLI. Install from PyPI with `pip`, `uv`, or any PEP 517 resolver; the optional `jwks` extra pulls in `httpx` for remote JWKS verification.
31+
Requires Python 3.11 or later. The package is published on PyPI as `agentruntimecontrolprotocol`; the import name stays `arcp`. The default install gives you the client, transports, and CLI out of the box — heavier server-side deps live behind extras so client-only users don't pull them in.
3232

3333
```sh
34-
pip install arcp
35-
# or, with uv:
36-
uv add arcp
37-
# with the JWKS extra:
38-
pip install "arcp[jwks]"
34+
# client side — submit and observe jobs
35+
pip install agentruntimecontrolprotocol
36+
37+
# runtime side — accept jobs, verify JWTs, persist event logs to sqlite
38+
pip install "agentruntimecontrolprotocol[runtime]"
39+
40+
# everything (runtime + otel + jwks)
41+
pip install "agentruntimecontrolprotocol[all]"
3942
```
4043

44+
Other extras: `[otel]` for OpenTelemetry middleware, `[jwks]` for remote JWKS verification via `httpx`, `[test]` for the pytest stack used by the suite.
45+
4146
## Quick start
4247

4348
Connect to a runtime, submit a job, stream its events to completion:

0 commit comments

Comments
 (0)