mirror of
https://github.com/openai/codex.git
synced 2026-04-30 03:12:20 +03:00
3cf1306968
2026-03-12 Switch the repo-source Python SDK real coverage over to a pinned runtime-package flow backed by GitHub release artifacts instead of PATH or explicit binary overrides. - add sdk/python/_runtime_setup.py to download the release codex archive for a requested CODEX_PYTHON_RUNTIME_VERSION, stage a temporary codex-cli-bin package, and install it into a target Python environment with cleanup - refactor real integration tests to run repo-source SDK code against an isolated site-packages target that contains the staged codex-cli-bin runtime - update examples and notebook bootstrap to install and use the runtime package, and stop consulting CODEX_PYTHON_SDK_CODEX_BIN or PATH - switch the failing turn-run and model-selection examples to runtime-compatible model selection for the pinned release binary - keep the main SDK runtime resolution model unchanged: explicit codex_bin or installed codex-cli-bin Validation: - python3 -m pytest sdk/python/tests - RUN_REAL_CODEX_TESTS=1 CODEX_PYTHON_RUNTIME_VERSION=0.115.0-alpha.11 python3 -m pytest sdk/python/tests/test_real_app_server_integration.py Co-authored-by: Codex <noreply@openai.com>
84 lines
2.7 KiB
Markdown
84 lines
2.7 KiB
Markdown
# Python SDK Examples
|
|
|
|
Each example folder contains runnable versions:
|
|
|
|
- `sync.py` (public sync surface: `Codex`)
|
|
- `async.py` (public async surface: `AsyncCodex`)
|
|
|
|
All examples intentionally use only public SDK exports from `codex_app_server`.
|
|
|
|
## Prerequisites
|
|
|
|
- Python `>=3.10`
|
|
- Install SDK dependencies for the same Python interpreter you will use to run examples
|
|
|
|
Recommended setup (from `sdk/python`):
|
|
|
|
```bash
|
|
python -m venv .venv
|
|
source .venv/bin/activate
|
|
python -m pip install -U pip
|
|
python -m pip install -e .
|
|
```
|
|
|
|
When running examples from this repo checkout, the SDK source uses the local
|
|
tree and does not bundle a runtime binary. The helper in `examples/_bootstrap.py`
|
|
uses the installed `codex-cli-bin` runtime package.
|
|
|
|
If `codex-cli-bin` is not already installed, set `CODEX_PYTHON_RUNTIME_VERSION`
|
|
to a release version like `0.115.0-alpha.11`; the bootstrap will download the
|
|
matching GitHub release artifact, stage a temporary local `codex-cli-bin`
|
|
package, install it into your active interpreter, and clean up the temporary
|
|
files afterward.
|
|
|
|
## Run examples
|
|
|
|
From `sdk/python`:
|
|
|
|
```bash
|
|
python examples/<example-folder>/sync.py
|
|
python examples/<example-folder>/async.py
|
|
```
|
|
|
|
The examples bootstrap local imports from `sdk/python/src` automatically, so no
|
|
SDK wheel install is required. You only need the Python dependencies for your
|
|
active interpreter and an installed `codex-cli-bin` runtime package (either
|
|
already present or provisioned through `CODEX_PYTHON_RUNTIME_VERSION`).
|
|
|
|
## Recommended first run
|
|
|
|
```bash
|
|
export CODEX_PYTHON_RUNTIME_VERSION=0.115.0-alpha.11
|
|
python examples/01_quickstart_constructor/sync.py
|
|
python examples/01_quickstart_constructor/async.py
|
|
```
|
|
|
|
## Index
|
|
|
|
- `01_quickstart_constructor/`
|
|
- first run / sanity check
|
|
- `02_turn_run/`
|
|
- inspect full turn output fields
|
|
- `03_turn_stream_events/`
|
|
- stream and print raw notifications
|
|
- `04_models_and_metadata/`
|
|
- read server metadata and model list
|
|
- `05_existing_thread/`
|
|
- resume a real existing thread (created in-script)
|
|
- `06_thread_lifecycle_and_controls/`
|
|
- thread lifecycle + control calls
|
|
- `07_image_and_text/`
|
|
- remote image URL + text multimodal turn
|
|
- `08_local_image_and_text/`
|
|
- local image + text multimodal turn using bundled sample image
|
|
- `09_async_parity/`
|
|
- parity-style sync flow (see async parity in other examples)
|
|
- `10_error_handling_and_retry/`
|
|
- overload retry pattern + typed error handling structure
|
|
- `11_cli_mini_app/`
|
|
- interactive chat loop
|
|
- `12_turn_params_kitchen_sink/`
|
|
- one turn using most optional `turn(...)` params (sync + async)
|
|
- `13_model_select_and_turn_params/`
|
|
- list models, pick highest model + highest supported reasoning effort, run turns, print message and usage
|