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

Files

T

Charlie MarshandGitHub c375deaf66 Use dependency groups for Python SDK tooling (#27538 )

## Summary

`just fmt` previously used `uv run --with ruff` to make Ruff available.
Because `--with` creates an ephemeral overlay outside the project
lockfile, uv periodically re-resolved Ruff (by default every 10 minutes)
instead of using the version recorded in `uv.lock`.

Move the Python SDK tooling dependencies from the published `dev` extra
into `format`, `test`, and composed `dev` dependency groups. The
formatter now selects only the locked `format` group, contributor and CI
setup explicitly sync the `dev` group, and CI and release commands reuse
that environment with `--frozen --no-sync`. The scripts formatter also
uses its project's locked Ruff dependency instead of an ephemeral
overlay.

Validated the Python 3.12 SDK suite (119 passed, 38 skipped) and the
repository formatter.

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

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 dependency groups for Python SDK tooling (#27538 )

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

_runtime_setup.py

sdk: launch packaged Codex runtimes (#23786 )

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

pyproject.toml

Use dependency groups for Python SDK tooling (#27538 )

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