mirror of https://github.com/openai/codex.git synced 2026-09-11 20:36:49 +00:00

Files

Ahmed Ibrahim 45134c0463 Generate Python SDK types from repository app-server schemas (#44032 )

## Why

Keep Python protocol models aligned with the checked-in app-server schemas and preserve reviewed generated artifacts when staging SDK releases.

## What changed

- Generate SDK types from the schema directory configured in `pyproject.toml`, with a `--schema-dir` override, instead of invoking the pinned runtime binary.
- Refresh Python artifacts through `just write-app-server-schema` for standard repository exports. Skip SDK updates for scratch and experimental exports.
- Regenerate protocol models and notification dispatch, deriving the known payload union from the registry so `Notification.payload` covers every registered event.
- Explicitly allowlist convenience API parameters so new protocol fields do not silently expand method signatures. Preserve existing approval path wrappers.
- Stage SDK releases using checked-in generated files without regenerating them.

## Testing

Add coverage for schema selection, refresh gating and failure handling, release artifact preservation, notification payload typing, and approval path compatibility. Update the generation drift test to use repository schemas.

GitOrigin-RevId: fab350b07cf170258b91fbafa8da384aeb2e3bd7

2026-09-09 03:27:31 +00:00

docs

Generate Python SDK types from repository app-server schemas (#44032 )

2026-09-09 03:27:31 +00:00

examples

Add max and ultra reasoning efforts to the SDKs (#39662 )

2026-08-20 08:20:08 +00:00

notebooks

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

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

scripts

Generate Python SDK types from repository app-server schemas (#44032 )

2026-09-09 03:27:31 +00:00

src/openai_codex

Generate Python SDK types from repository app-server schemas (#44032 )

2026-09-09 03:27:31 +00:00

tests

Generate Python SDK types from repository app-server schemas (#44032 )

2026-09-09 03:27:31 +00:00

_runtime_setup.py

Support alpha hotfix release versions (#34463 )

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

pyproject.toml

Generate Python SDK types from repository app-server schemas (#44032 )

2026-09-09 03:27: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.147.0 stable release (#39155 )

2026-08-18 06:43:10 +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.