mirror of https://github.com/openai/codex.git synced 2026-08-23 13:09:46 +00:00

Files

Michael Bolin 9970cd706f Support alpha hotfix release versions (#34463 )

## What changed

- Map Python `aN.postM` versions to Codex `-alpha.N.M` release tags through shared release-version helpers.
- Accept alpha hotfix versions in Python runtime workflows, Rust release validation, npm publishing, and the shell and PowerShell installers.

## Testing

- Cover version conversion, workflow output, runtime setup, artifact staging, and installer handling for alpha hotfix releases.

GitOrigin-RevId: b95edb56f7c93b435a8050c10f0202dc117e6669

2026-07-21 03:59:38 +00:00

docs

Prepare Python SDK 0.144.4 stable release (#33213 )

2026-07-15 02:43:31 +00:00

examples

Prepare Python SDK 0.144.4 stable release (#33213 )

2026-07-15 02:43:31 +00:00

notebooks

[sdk/python] Stop advertising HTTP image URLs (#29464 )

2026-06-22 11:34:14 -07:00

scripts

Support alpha hotfix release versions (#34463 )

2026-07-21 03:59:38 +00:00

src/openai_codex

Prepare Python SDK 0.144.4 stable release (#33213 )

2026-07-15 02:43:31 +00:00

tests

Support alpha hotfix release versions (#34463 )

2026-07-21 03:59:38 +00:00

_runtime_setup.py

Support alpha hotfix release versions (#34463 )

2026-07-21 03:59:38 +00:00

pyproject.toml

Prepare Python SDK 0.144.4 stable release (#33213 )

2026-07-15 02:43:31 +00:00

README.md

Prepare Python SDK 0.144.4 stable release (#33213 )

2026-07-15 02:43:31 +00:00

release_version.py

Support alpha hotfix release versions (#34463 )

2026-07-21 03:59:38 +00:00

uv.lock

Prepare Python SDK 0.144.4 stable release (#33213 )

2026-07-15 02:43:31 +00:00

README.md

OpenAI Codex Python SDK

Build Python applications that start Codex threads, run turns, stream progress, and control workspace access.

Install

Install the SDK:

pip install openai-codex

Quickstart

The SDK reuses your existing Codex authentication when one is already available:

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:

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:

with Codex() as codex:
    login = codex.login_chatgpt_device_code()
    print(login.verification_url, login.user_code)
    login.wait()

For API-key login:

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

The package is licensed under the repository Apache License 2.0.