mirror of
https://github.com/pchuan98/codex.git
synced 2026-07-01 00:31:56 +08:00
Ahmed Ibrahim
d0663f8004
## Summary - Remove the exact-version install snippet from the PyPI-facing Python SDK README. - Remove the release-selection explanation so the install section presents the standard `pip install openai-codex` path directly. ## Validation - Not run locally; relying on online CI for this documentation-only change.
78 lines
1.8 KiB
Markdown
78 lines
1.8 KiB
Markdown
# OpenAI Codex Python SDK (Beta)
|
|
|
|
Build Python applications that start Codex threads, run turns, stream progress,
|
|
and control workspace access.
|
|
|
|
> [!NOTE]
|
|
> `openai-codex` is in beta. Public APIs may change before `1.0`.
|
|
|
|
## Install
|
|
|
|
Install the SDK:
|
|
|
|
```bash
|
|
pip install openai-codex
|
|
```
|
|
|
|
## Quickstart
|
|
|
|
The SDK reuses your existing Codex authentication when one is already
|
|
available:
|
|
|
|
```python
|
|
from openai_codex import Codex
|
|
|
|
with Codex() as codex:
|
|
thread = codex.thread_start()
|
|
result = thread.run("Explain this repository in three bullets.")
|
|
print(result.final_response)
|
|
```
|
|
|
|
`thread.run(...)` returns a `TurnResult` containing the final response,
|
|
collected items, and token usage.
|
|
|
|
## Authentication
|
|
|
|
Existing Codex authentication is reused automatically. To start ChatGPT
|
|
browser login explicitly:
|
|
|
|
```python
|
|
from openai_codex import Codex
|
|
|
|
with Codex() as codex:
|
|
login = codex.login_chatgpt()
|
|
print(login.auth_url)
|
|
print(login.wait().success)
|
|
```
|
|
|
|
For device-code login:
|
|
|
|
```python
|
|
with Codex() as codex:
|
|
login = codex.login_chatgpt_device_code()
|
|
print(login.verification_url, login.user_code)
|
|
login.wait()
|
|
```
|
|
|
|
For API-key login:
|
|
|
|
```python
|
|
with Codex() as codex:
|
|
codex.login_api_key("sk-...")
|
|
```
|
|
|
|
## Built-In Help
|
|
|
|
Use Python's standard `help(openai_codex)`, `help(Codex)`, or
|
|
`python -m pydoc openai_codex` documentation tools.
|
|
|
|
## Documentation
|
|
|
|
- [Getting started](https://github.com/openai/codex/blob/main/sdk/python/docs/getting-started.md)
|
|
- [API reference](https://github.com/openai/codex/blob/main/sdk/python/docs/api-reference.md)
|
|
- [FAQ](https://github.com/openai/codex/blob/main/sdk/python/docs/faq.md)
|
|
- [Examples](https://github.com/openai/codex/blob/main/sdk/python/examples/README.md)
|
|
|
|
The package is licensed under the
|
|
[repository Apache License 2.0](https://github.com/openai/codex/blob/main/LICENSE).
|