Skip to content

Commit 39476de

Browse files
committed
update readme
1 parent 0fdd7ae commit 39476de

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

README.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,40 @@
1-
# A2A SDK (Prototype)
1+
# A2A Python SDK
22

3-
Early version of the A2A Python SDK.
3+
A python library that helps run agentic applications as A2AServers.
44

5-
## Install SDK
5+
## Installation
66

7-
```bash
8-
pip install .
9-
```
7+
You can install the a2a-sdk using either `uv` or `pip`.
108

11-
## Verify install
9+
## Prerequisites
10+
* Python 3.13+
11+
* `uv` (optional, but recommended) or `pip`
1212

13-
```py
14-
import a2a
15-
```
13+
### using `uv`
1614

17-
## Run Helloworld
18-
19-
Run Remote Agent
15+
When you're working within a uv project or a virtual environment managed by uv, the preferred way to add packages is using uv add.
2016

2117
```bash
22-
cd examples/helloworld
23-
python __main__.py
18+
uv add a2a-sdk
2419
```
2520

26-
In another terminal, run the client
21+
### using `pip`
22+
23+
If you prefer to use pip, the standard Python package installer, you can install a2a-sdk as follows
2724

2825
```bash
29-
python test_client.py
26+
pip install a2a-sdk
3027
```
3128

29+
## Examples
30+
31+
A simple hello world example agent is available here:
32+
33+
* [Hello World example](https://github.com/google/a2a-python/tree/main/examples/helloworld)
34+
35+
You can also find more examples [here](https://github.com/google/A2A/tree/main/samples/python/agents)
36+
37+
3238
## License
3339

3440
This project is licensed under the terms of the [Apache 2.0 License](LICENSE).

0 commit comments

Comments
 (0)