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

Files

T

Charlie Marsh 94427aaf46 Use uv as Python SDK build backend (#27901 )

## Summary

Replace Hatchling with uv's build backend for the Python SDK. The
backend infers the `src/openai_codex` module from the normalized project
name and standard source layout, so no uv-specific package configuration
is required.

This keeps Python packaging within the uv toolchain already used for
dependency management and release builds. A controlled before-and-after
PEP 517 comparison produced identical wheel package paths, bytes,
permissions, and semantic metadata. The sdist retains the SDK package
tree, root README, and project metadata while dropping the unrelated
examples README that Hatch included through its broad include matching.

94427aaf46 · 2026-06-12 17:21:00 +00:00

History

docs

Use dependency groups for Python SDK tooling (#27538 )

2026-06-12 16:10:07 +00:00

examples

Use dependency groups for Python SDK tooling (#27538 )

2026-06-12 16:10:07 +00: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

Use uv as Python SDK build backend (#27901 )

2026-06-12 17:21:00 +00:00

_runtime_setup.py

sdk: launch packaged Codex runtimes (#23786 )

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

pyproject.toml

Use uv as Python SDK build backend (#27901 )

2026-06-12 17:21:00 +00:00

README.md

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

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

uv.lock

Use dependency groups for Python SDK tooling (#27538 )

2026-06-12 16:10:07 +00: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.