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

Files

T

rka-oai 20431d49a0 [sdk/python] Stop advertising HTTP image URLs (#29464 )

## Summary

- use generated image data URLs in the Python SDK examples and notebook
- document HTTP and HTTPS image URLs as deprecated and recommend
`LocalImageInput`
- replace the remote-URL integration test with data-URL coverage

`ImageInput` remains available for data URLs. The SDK does not duplicate
app-server URL validation.

## Testing

- `uv run --frozen --no-sync ruff check --output-format=full .`
- `uv run --frozen --no-sync ruff format --check .`
- full Python SDK test suite with an isolated writable
`CODEX_SQLITE_HOME` (119 passed, 38 skipped)

20431d49a0 · 2026-06-22 11:34:14 -07:00

History

docs

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

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

examples

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

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

notebooks

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

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

scripts

[codex] Pin Python SDK to glibc-compatible runtime (#25907 )

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

src/openai_codex

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

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

tests

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

2026-06-22 11:34:14 -07: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.