mirror of
https://github.com/openai/codex.git
synced 2026-11-18 22:20:48 +00:00
## Why Using `uv run --frozen` keeps dependency resolution fixed but does not require installed packages to match the hashes in `uv.lock`. ## What changed Run Ruff for the Python SDK and repository scripts, and regenerate Python SDK types during repository schema refreshes, through a shared runner. It exports the selected locked dependencies, installs them into a temporary virtual environment with `uv pip sync --require-hashes`, and runs the tool without resyncing the environment. ## Testing Update tests to check the formatter invocations and verify that only repository schema refreshes invoke Python type generation through the runner. GitOrigin-RevId: 4e84da5d227eb99c24efb9a1cc7647af82105536
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.