codex-python 0.1.1__py3-none-any.whl → 0.2.0__py3-none-any.whl

{codex_python-0.1.1.dist-info → codex_python-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codex-python
-Version: 0.1.1
+Version: 0.2.0
 Summary: A minimal Python library scaffold for codex-python
 Project-URL: Homepage, https://github.com/gersmann/codex-python
 Project-URL: Repository, https://github.com/gersmann/codex-python
@@ -36,15 +36,16 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: >=3.13
+Requires-Dist: pydantic>=2.11.7
 Description-Content-Type: text/markdown
 
 # codex-python
 
-A minimal Python library scaffold using `uv` with Python 3.13+.
+Python interface to Codex, packaged as a single distribution (`codex-python`). Platform wheels include a native extension for in‑process execution. The library consolidates on native bindings (no subprocess wrapper).
 
 ## Quickstart
 
-- Requires Python 3.13+.
+- Requires Python 3.12+.
 - Package import name: `codex`.
 - Distribution name (PyPI): `codex-python`.
 
@@ -55,30 +56,39 @@ A minimal Python library scaffold using `uv` with Python 3.13+.
 
 ## Usage
 
-Basic non-interactive execution via Codex CLI:
+Native, non-interactive execution with Pydantic config:
 
 ```
-from codex import run_exec
+from codex.api import run_exec, CodexClient
+from codex.config import CodexConfig, ApprovalPolicy, SandboxMode
 
-out = run_exec("explain this repo")
-print(out)
-```
+cfg = CodexConfig(
+    model="gpt-5",
+    model_provider="openai",
+    approval_policy=ApprovalPolicy.ON_REQUEST,
+    sandbox_mode=SandboxMode.WORKSPACE_WRITE,
+)
 
-Options:
+events = run_exec("explain this repo", config=cfg)
 
-- Choose model: `run_exec("...", model="gpt-4.1")`
-- Full auto: `run_exec("scaffold a cli", full_auto=True)`
-- Run in another dir: `run_exec("...", cd="/path/to/project")`
+client = CodexClient(config=cfg)
+for ev in client.start_conversation("add a smoke test"):
+    print(ev)
+```
 
-Using a client with defaults:
+To stream raw dict events directly from the native layer:
 
 ```
-from codex import CodexClient
+from codex.native import start_exec_stream
 
-client = CodexClient(model="gpt-4.1", full_auto=True)
-print(client.run("explain this repo"))
+for e in start_exec_stream("explain this repo", config_overrides=cfg.to_dict()):
+    # each `e` is a dict representing an event envelope
+    print(e)
 ```
 
+The event payload is typed: `Event.msg` is a union `EventMsg` from `codex.protocol.types`,
+and is also exported at `codex.EventMsg` for convenience.
+
 ### Install uv
 
 - macOS (Homebrew): `brew install uv`
@@ -125,6 +135,61 @@ uv publish --token "$PYPI_API_TOKEN"
 - Format: `make fmt` (ruff formatter)
  - Pre-commit: `uvx pre-commit install && uvx pre-commit run --all-files`
 
+### Protocol bindings (from codex-rs)
+
+- Prereq: Rust toolchain (`cargo`) installed.
+- Generate Python types from the upstream protocol with:
+
+```
+make gen-protocol
+```
+
+This will:
+- emit TypeScript types under `.generated/ts/`
+- convert them to Python Pydantic models + Literal unions at `codex/protocol/types.py`
+
+### Native bindings (PyO3)
+
+- Install path
+
+`pip install codex-python` installs a platform wheel that includes the native extension on supported platforms (Python 3.12/3.13; CI also attempts 3.14).
+
+- Build locally (requires Rust + maturin):
+
+```
+make dev-native
+```
+
+- Notes:
+  - The native path embeds Codex directly; no subprocess.
+  - A helper `codex.native.preview_config(...)` returns a compact snapshot of the effective configuration (selected fields) for tests and introspection.
+
+### Configuration (Pydantic)
+
+Use the `CodexConfig` Pydantic model to pass overrides which mirror the Rust `ConfigOverrides`:
+
+```
+from codex.config import CodexConfig, ApprovalPolicy, SandboxMode
+from codex.api import run_exec, CodexClient
+
+cfg = CodexConfig(
+    model="gpt-5",
+    model_provider="openai",
+    approval_policy=ApprovalPolicy.ON_REQUEST,
+    sandbox_mode=SandboxMode.WORKSPACE_WRITE,
+    cwd="/path/to/project",
+    include_apply_patch_tool=True,
+)
+
+events = run_exec("Explain this project", config=cfg)
+
+client = CodexClient(config=cfg)
+for ev in client.start_conversation("Add a test for feature X"):
+    print(ev)
+```
+
+`CodexConfig.to_dict()` emits only set (non‑None) fields and serializes enums to their kebab‑case strings to match the native Rust types.
+
 ## Project Layout
 
 ```
@@ -142,4 +207,4 @@ Version is managed via `codex/__init__.py` and exposed as `__version__`. The bui
 
 ## Python Compatibility
 
-- Requires Python `>=3.13`.
+- Supported: Python 3.12, 3.13. CI attempts 3.14 wheels when available.

codex_python-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+codex/__init__.py,sha256=xlyhxrsoviZDinInmCg1mHhybg5gFtxuuPKe4-WKp3w,606
+codex/api.py,sha256=FhRSIAu5dpwTB4sO2qjuVjH_akFoDAG-2wyAyRSGCvw,2892
+codex/config.py,sha256=388mrVtzyA6t8qigS8JxFSFPJbT3A-KMDMP-YQo6rUs,2869
+codex/event.py,sha256=HPS6ySBa7Pwn4gRjQKj2yUE5_kiad4WFqwmA7aEdoiI,387
+codex/native.py,sha256=ukaOK5U96oaJaY80sFSUSFNhRv1Wefix_8M-BCUat7A,2063
+codex/protocol/types.py,sha256=YxnQBq5sgV_JC7E0q5Hkp8EIRcpvSTnBm1Uhv4Lc4Zs,38558
+codex/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+codex_python-0.2.0.dist-info/METADATA,sha256=hLsX65ljGft-oPgvimWlDACHJAytrB1yjSxFW97fESw,6599
+codex_python-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+codex_python-0.2.0.dist-info/licenses/LICENSE,sha256=ZhGahTKhsCbPWNmZ7ugZ14LVewMo4Gh1OeIOlQabyrI,1066
+codex_python-0.2.0.dist-info/RECORD,,

codex_python-0.1.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-codex/__init__.py,sha256=FsirGg1w3wP202sQMBOAOHkjglZU20dtRI6ZFLbN3z4,514
-codex/api.py,sha256=aP1OcnMxSF-vJyxwVIllbydmrFiUESsuePvCyYkBXxo,4614
-codex/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-codex_python-0.1.1.dist-info/METADATA,sha256=2_XGcNNm1g1q--mnoJSktrsdNo6IbZS3kcI0mcnXlcw,4351
-codex_python-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-codex_python-0.1.1.dist-info/licenses/LICENSE,sha256=ZhGahTKhsCbPWNmZ7ugZ14LVewMo4Gh1OeIOlQabyrI,1066
-codex_python-0.1.1.dist-info/RECORD,,