Skip to content

Document mutual exclusivity with openai-harmony #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bbrowning merged 1 commit into from
May 14, 2026
Merged

Document mutual exclusivity with openai-harmony #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,15 @@ pip install oss-harmony
uv pip install oss-harmony
```

> **Note:** `oss-harmony` and `openai-harmony` both provide the `openai_harmony` Python
> module. Do not install both packages in the same environment — pip will silently
> overwrite one with the other. If you are switching between packages, uninstall the
> existing one first:
>
> ```bash
> pip uninstall openai-harmony && pip install oss-harmony
> ```

#### Example

```python
Expand Down
9 changes: 9 additions & 0 deletions docs/python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ Install the package from PyPI:
pip install oss-harmony
```

> **Note:** `oss-harmony` and `openai-harmony` both provide the `openai_harmony` Python
> module. Do not install both packages in the same environment — pip will silently
> overwrite one with the other. If you are switching between packages, uninstall the
> existing one first:
>
> ```bash
> pip uninstall openai-harmony && pip install oss-harmony
> ```

Typical imports look like:

```python
Expand Down
Loading