mirror of https://github.com/openai/codex.git synced 2026-08-23 13:09:46 +00:00

Files

Ahmed Ibrahim 4a53b09eb7 [codex] Remove Python SDK language classifiers (#24868 )

## Summary
- Remove the Python language classifiers from the Python SDK package
metadata.
- Keep `requires-python = ">=3.10"` as the package's interpreter
compatibility constraint.
- Avoid presenting a curated version-support list in PyPI metadata.

## Validation
- Not run locally; relying on online CI for this metadata-only change.

## Release
- Land this change before publishing the next Python SDK beta.

2026-05-27 23:09:34 -07:00

docs

[codex] Prepare Python SDK beta documentation and package metadata (#24836 )

2026-05-27 18:29:05 -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] Prepare Python SDK beta documentation and package metadata (#24836 )

2026-05-27 18:29:05 -07:00

src/openai_codex

[codex] Prepare Python SDK beta documentation and package metadata (#24836 )

2026-05-27 18:29:05 -07:00

tests

[codex] Prepare Python SDK beta documentation and package metadata (#24836 )

2026-05-27 18:29:05 -07:00

_runtime_setup.py

sdk: launch packaged Codex runtimes (#23786 )

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

pyproject.toml

[codex] Remove Python SDK language classifiers (#24868 )

2026-05-27 23:09:34 -07:00

README.md

[codex] Simplify Python SDK install guidance (#24866 )

2026-05-27 23:01:42 -07:00

uv.lock

[codex] Add independent beta release for the Python SDK (#24828 )

2026-05-27 17:57:51 -07:00

README.md

OpenAI Codex Python SDK (Beta)

Build Python applications that start Codex threads, run turns, stream progress, and control workspace access.

Note

openai-codex is in beta. Public APIs may change before 1.0.

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.