mirror of https://github.com/openai/codex.git synced 2026-05-30 07:50:17 +00:00

Files

Ahmed Ibrahim 46946bb91c [codex] Stage Python SDK beta versions from release tags (#24872 )

## Summary
- Treat `sdk/python` as a development template with source version
`0.0.0-dev`, matching the existing Python runtime packaging pattern.
- Have `python-v*` tags supply the published SDK beta version through
the existing `stage-sdk --sdk-version` path.
- Remove the workflow check requiring a source version bump for each
beta release and remove its now-unused host Python setup step.
- Keep the reviewed runtime dependency pin at
`openai-codex-cli-bin==0.132.0`.
- Remove beta-number-specific documentation so it does not need editing
for each publish.

## Why
The package staging script already writes the release version into the
artifact. Requiring the checked-in SDK template version to match every
tag adds release-only source churn without changing the package users
receive.

## Validation
- Not run locally; relying on online CI for this workflow and metadata
change.

## Release
After this PR lands, publish the next beta by pushing tag
`python-v0.1.0b2` from merged `main`.

2026-05-27 23:24:42 -07:00

docs

[codex] Stage Python SDK beta versions from release tags (#24872 )

2026-05-27 23:24:42 -07:00

examples

[codex] Prepare Python SDK beta documentation and package metadata (#24836 )

2026-05-27 18:29:05 -07:00

notebooks

[codex] Add friendly Python SDK sandbox presets (#24772 )

2026-05-27 11:11:04 -07:00

scripts

[codex] Prepare Python SDK beta documentation and package metadata (#24836 )

2026-05-27 18:29:05 -07:00

src/openai_codex

[codex] Prepare Python SDK beta documentation and package metadata (#24836 )

2026-05-27 18:29:05 -07:00

tests

[codex] Stage Python SDK beta versions from release tags (#24872 )

2026-05-27 23:24:42 -07:00

_runtime_setup.py

sdk: launch packaged Codex runtimes (#23786 )

2026-05-20 18:01:22 -07:00

pyproject.toml

[codex] Stage Python SDK beta versions from release tags (#24872 )

2026-05-27 23:24:42 -07:00

README.md

[codex] Remove Python SDK beta warning note (#24870 )

2026-05-27 23:13:48 -07:00

uv.lock

[codex] Stage Python SDK beta versions from release tags (#24872 )

2026-05-27 23:24:42 -07:00

README.md

OpenAI Codex Python SDK (Beta)

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.