Skip to content
Closed
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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ For voice support, install with the optional `voice` group: `pip install 'openai

For Redis session support, install with the optional `redis` group: `pip install 'openai-agents[redis]'`.

> [!NOTE]
> **For developers working on this project:** When working within the `openai-agents-python` repository, use `pip install -e '.[voice]'` or `pip install -e '.[redis]'` to install the project in editable mode with optional dependencies, instead of installing from PyPI.

### uv

If you're familiar with [uv](https://docs.astral.sh/uv/), using the tool would be even similar:
Expand All @@ -46,6 +49,9 @@ For voice support, install with the optional `voice` group: `uv add 'openai-agen

For Redis session support, install with the optional `redis` group: `uv add 'openai-agents[redis]'`.

> [!NOTE]
> **For developers working on this project:** When working within the `openai-agents-python` repository, use `uv sync --extra voice` or `uv sync --extra redis` instead of `uv add`, as the project cannot install itself as a dependency.

## Hello world example

```python
Expand Down