mirror of
https://github.com/pchuan98/codex.git
synced 2026-07-01 00:31:56 +08:00
Ahmed Ibrahim
eb1cc3824c
## Why The initial public `openai-codex` beta should read and install like a normal published Python package before a release tag is created. This follows merged PR #24828, which establishes the independent SDK beta release plumbing and exact runtime dependency. ## What changed - Rewrote `sdk/python/README.md` as a compact PyPI-facing beta package page: published installation, one quickstart, short login examples, built-in help, and links to deeper guides. - Updated the getting-started guide, API reference, FAQ, and examples index to present the published beta consistently without repeating onboarding in the package landing page or reference page. - Made `pip install openai-codex` the primary install path while beta releases are the only published SDK releases, with `--pre` documented for opting into prereleases after a stable release exists. - Added curated `help()` / `pydoc` docstrings across the public API and generated public convenience methods through `scripts/update_sdk_artifacts.py`. - Declared the repository `Apache-2.0` license expression and Documentation URL in package metadata, without introducing a duplicated SDK-local license file. - Kept the source distribution focused on installable package material (`src/openai_codex`, `README.md`, and `pyproject.toml`); the repository docs and runnable examples remain linked from the PyPI README. - Built release artifacts in an Alpine container on the Ubuntu runner, matching Python SDK CI and allowing type generation to install the published `musllinux` runtime wheel. - Added `twine check --strict` to the release workflow so malformed PyPI metadata or rendered README content fails before publishing. - Added focused SDK assertions for beta metadata, the exact runtime pin, source distribution contents, and the built-in Python documentation surface. ## Validation - Ran `uv run --frozen --extra dev ruff check scripts/update_sdk_artifacts.py src/openai_codex tests/test_public_api_signatures.py tests/test_artifact_workflow_and_binaries.py` before the final README-only reductions and review-fix follow-ups. - Built `openai_codex-0.1.0b1-py3-none-any.whl` and `openai_codex-0.1.0b1.tar.gz` before the final README-only reductions and review-fix follow-ups. - Ran `python -m twine check --strict` on both built artifacts before the final README-only reductions and review-fix follow-ups. - Verified artifact metadata reports `Apache-2.0` without a duplicated SDK-local license file. - Verified `inspect.getdoc(...)` resolves documentation for the package, `Codex`, `CodexConfig`, and key generated thread methods. - Rebased the documentation/readiness change onto merged PR #24828 without changing the intended SDK or workflow file contents. - Final verification is delegated to online CI for this PR.
90 lines
2.2 KiB
Markdown
90 lines
2.2 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
|
|
```
|
|
|
|
For reproducible environments, install this release exactly:
|
|
|
|
```bash
|
|
pip install openai-codex==0.1.0b1
|
|
```
|
|
|
|
The SDK requires Python `>=3.10` and installs its compatible Codex runtime
|
|
dependency automatically. While beta releases are the only published SDK
|
|
releases, the normal install command selects the latest beta. After a stable
|
|
release exists, use `pip install --pre openai-codex` to explicitly select a
|
|
newer prerelease.
|
|
|
|
## 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).
|