Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to `agent-client-protocol-python`
# Contributing to `agentclientprotocol/python-sdk`

Contributions are welcome, and they are greatly appreciated!
Every little bit helps, and credit will always be given.
Expand All @@ -9,7 +9,7 @@ You can contribute in many ways:

## Report Bugs

Report bugs at https://github.com/psiace/agent-client-protocol-python/issues
Report bugs at https://github.com/agentclientprotocol/python-sdk/issues

If you are reporting a bug, please include:

Expand All @@ -29,11 +29,11 @@ Anything tagged with "enhancement" and "help wanted" is open to whoever wants to

## Write Documentation

agent-client-protocol-python could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
This project could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.

## Submit Feedback

The best way to send feedback is to file an issue at https://github.com/psiace/agent-client-protocol-python/issues.
The best way to send feedback is to file an issue at https://github.com/agentclientprotocol/python-sdk/issues.

If you are proposing a new feature:

Expand All @@ -44,22 +44,22 @@ If you are proposing a new feature:

# Get Started!

Ready to contribute? Here's how to set up `agent-client-protocol-python` for local development.
Ready to contribute? Here's how to set up the project for local development.
Please note this documentation assumes you already have `uv` and `Git` installed and ready to go.

1. Fork the `agent-client-protocol-python` repo on GitHub.
1. Fork the `agentclientprotocol/python-sdk` repo on GitHub.

2. Clone your fork locally:

```bash
cd <directory_in_which_repo_should_be_created>
git clone git@github.com:YOUR_NAME/agent-client-protocol-python.git
git clone git@github.com:YOUR_NAME/python-sdk.git
```

3. Now we need to install the environment. Navigate into the directory

```bash
cd agent-client-protocol-python
cd python-sdk
```

Then, install and activate the environment with:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ uv add agent-client-protocol
```
2. Wire it into your client (e.g. Zed → Agents panel) so stdio is connected; the SDK handles JSON-RPC framing and lifecycle messages.

Prefer a step-by-step walkthrough? Read the [Quickstart guide](docs/quickstart.md) or the hosted docs: https://psiace.github.io/agent-client-protocol-python/.
Prefer a step-by-step walkthrough? Read the [Quickstart guide](docs/quickstart.md) or the hosted docs: https://agentclientprotocol.github.io/python-sdk/.

### Launching from Python

Expand Down Expand Up @@ -162,7 +162,7 @@ Read more in [docs/contrib.md](docs/contrib.md).

## Documentation

- Project docs (MkDocs): https://psiace.github.io/agent-client-protocol-python/
- Project docs (MkDocs): https://agentclientprotocol.github.io/python-sdk/
- Local sources: `docs/`
- [Quickstart](docs/quickstart.md)
- [Contrib helpers](docs/contrib.md)
Expand Down
10 changes: 5 additions & 5 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Add an Agent Server entry in `settings.json` (Zed → Settings → Agents panel)
"Echo Agent (Python)": {
"command": "/abs/path/to/python",
"args": [
"/abs/path/to/agent-client-protocol-python/examples/echo_agent.py"
"/abs/path/to/agentclientprotocol/python-sdk/examples/echo_agent.py"
]
}
}
Expand Down Expand Up @@ -103,10 +103,10 @@ class MyAgent(Agent):

Hook it up with `AgentSideConnection` inside an async entrypoint and wire it to your client. Refer to:

- [`examples/echo_agent.py`](https://github.com/psiace/agent-client-protocol-python/blob/main/examples/echo_agent.py) for the smallest streaming agent
- [`examples/agent.py`](https://github.com/psiace/agent-client-protocol-python/blob/main/examples/agent.py) for an implementation that negotiates capabilities and streams richer updates
- [`examples/duet.py`](https://github.com/psiace/agent-client-protocol-python/blob/main/examples/duet.py) to see `spawn_agent_process` in action alongside the interactive client
- [`examples/gemini.py`](https://github.com/psiace/agent-client-protocol-python/blob/main/examples/gemini.py) to drive the Gemini CLI (`--experimental-acp`) directly from Python
- [`examples/echo_agent.py`](https://github.com/agentclientprotocol/python-sdk/blob/main/examples/echo_agent.py) for the smallest streaming agent
- [`examples/agent.py`](https://github.com/agentclientprotocol/python-sdk/blob/main/examples/agent.py) for an implementation that negotiates capabilities and streams richer updates
- [`examples/duet.py`](https://github.com/agentclientprotocol/python-sdk/blob/main/examples/duet.py) to see `spawn_agent_process` in action alongside the interactive client
- [`examples/gemini.py`](https://github.com/agentclientprotocol/python-sdk/blob/main/examples/gemini.py) to drive the Gemini CLI (`--experimental-acp`) directly from Python

Need builders for common payloads? `acp.helpers` mirrors the Go/TS helper APIs:

Expand Down
10 changes: 5 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
site_name: Agent Client Protocol - Python SDK
repo_url: https://github.com/psiace/agent-client-protocol-python
site_url: https://psiace.github.io/agent-client-protocol-python
repo_url: https://github.com/agentclientprotocol/python-sdk
site_url: https://agentclientprotocol.github.io/python-sdk
site_description: A Python implement of Agent Client Protocol (ACP, by Zed Industries)
site_author: Chojan Shang
edit_uri: edit/main/docs/
repo_name: psiace/agent-client-protocol-python
repo_name: agentclientprotocol/python-sdk
copyright: Maintained by <a href="https://github.com/psiace">psiace</a>.

nav:
Expand Down Expand Up @@ -43,9 +43,9 @@ theme:
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/psiace/agent-client-protocol-python
link: https://github.com/agentclientprotocol/python-sdk
- icon: fontawesome/brands/python
link: https://pypi.org/project/agent-client-protocol-python
link: https://pypi.org/project/agent-client-protocol

markdown_extensions:
- toc:
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ dependencies = [


[project.urls]
Homepage = "https://psiace.github.io/agent-client-protocol-python/"
Repository = "https://github.com/psiace/agent-client-protocol-python"
Documentation = "https://psiace.github.io/agent-client-protocol-python/"
Homepage = "https://agentclientprotocol.github.io/python-sdk/"
Repository = "https://github.com/agentclientprotocol/python-sdk"
Documentation = "https://agentclientprotocol.github.io/python-sdk/"

[dependency-groups]
dev = [
Expand Down
Loading