docs: #2023 update readme to reflect commands required for developers #2024
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes installation instructions in README.md for developers working on the
openai-agents-pythonrepository itself. The original instructions failed when developers tried to install optional dependencies (voiceandredisextras) because:For
pip:pip install 'openai-agents[voice]'would install from PyPI instead of the local codebase, preventing developers from testing their changes.For
uv:uv add 'openai-agents[voice]'would attempt to add the project as its own dependency, whichuvprevents with the error: "self-dependencies are not permitted without the--devor--optionalflags."This PR adds developer-specific notes that clarify the correct commands:
pip: Usepip install -e '.[voice]'to install in editable mode from the local directoryuv: Useuv sync --extra voiceto sync optional dependencies without adding the project as a dependencyThe changes maintain backward compatibility—end users can still follow the original instructions, while developers now have clear guidance.
Test plan
uv sync --extra voiceworks correctly in the repositorypip install -e '.[voice]'would work (editable install from local directory)uv add 'openai-agents[voice]'fails with the expected error message when run inside the repositoryIssue number
#2023
Checks
make lintandmake format