Skip to content
Merged
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
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,28 @@ Explore the [examples](examples) directory to see the SDK in action, and read ou

## Get started

1. Set up your Python environment
To get started, set up your Python environment (Python 3.9 or newer required), and then install OpenAI Agents SDK package.

- Option A: Using venv (traditional method)
### venv

```bash
python -m venv env
source env/bin/activate # On Windows: env\Scripts\activate
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
pip install openai-agents
```

- Option B: Using uv (recommended)
For voice support, install with the optional `voice` group: `pip install 'openai-agents[voice]'`.

```bash
uv venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
```
### uv

2. Install Agents SDK
If you're familiar with [uv](https://docs.astral.sh/uv/), using the tool would be even similar:

```bash
pip install openai-agents
uv init
uv add openai-agents
```

For voice support, install with the optional `voice` group: `pip install 'openai-agents[voice]'`.
For voice support, install with the optional `voice` group: `uv add 'openai-agents[voice]'`.

## Hello world example

Expand Down