mirror of https://github.com/pchuan98/codex.git synced 2026-07-01 00:31:56 +08:00

Files

T

Ahmed IbrahimandGitHub 9316acf9b2 [2/4] Add private Python goal operations (#27111 )

## Why

The Python SDK must treat the runtime's initial goal turn and its
continuations as one logical operation. That requires a private
lifecycle engine before the public API can return the existing turn
handle and result types.

## What

- start goals by composing the existing clear/set goal RPCs
- enforce persisted, idle threads and a bounded startup handshake
- coalesce continuation notifications under a stable logical turn ID
- aggregate items, usage, timing, and terminal status
- support rollover-aware steering, interruption, cancellation, and
cleanup
- provide equivalent sync and async internals

This is the second PR in the stack and intentionally adds no public API.

## Test plan

- online CI, including the Python SDK suite
- behavioral coverage is added in the following two stack PRs

2026-06-09 15:32:15 -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] Pin Python SDK to glibc-compatible runtime (#25907 )

2026-06-02 12:27:01 -07:00

src/openai_codex

[2/4] Add private Python goal operations (#27111 )

2026-06-09 15:32:15 -07:00

tests

[2/4] Add private Python goal operations (#27111 )

2026-06-09 15:32:15 -07:00

_runtime_setup.py

sdk: launch packaged Codex runtimes (#23786 )

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

pyproject.toml

[codex] Pin Python SDK to runtime 0.137.0a4 (#26216 )

2026-06-03 12:14:14 -07:00

README.md

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

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

uv.lock

[codex] Pin Python SDK to runtime 0.137.0a4 (#26216 )

2026-06-03 12:14:14 -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.