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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codex-python
-Version: 0.1.2
+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
@@ -41,11 +41,11 @@ 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`.
 
@@ -56,42 +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)
-```
-
-Options:
-
-- 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")`
+cfg = CodexConfig(
+    model="gpt-5",
+    model_provider="openai",
+    approval_policy=ApprovalPolicy.ON_REQUEST,
+    sandbox_mode=SandboxMode.WORKSPACE_WRITE,
+)
 
-Streaming JSON events (no PyO3 required):
+events = run_exec("explain this repo", config=cfg)
 
+client = CodexClient(config=cfg)
+for ev in client.start_conversation("add a smoke test"):
+    print(ev)
 ```
-from codex.protocol.runtime import stream_exec_events
-
-for event in stream_exec_events("explain this repo", full_auto=True):
-    # event is a dict with shape {"id": str, "msg": {...}}
-    print(event)
-```
-
-The event payload matches the Pydantic models in `codex.protocol.types` (e.g., `EventMsg`).
 
-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`
@@ -148,8 +145,50 @@ make gen-protocol
 ```
 
 This will:
-- run `codex-proj/codex-rs/protocol-ts` to emit TypeScript types under `.generated/ts/`
-- convert them to Python `TypedDict`/`Literal` aliases at `codex/protocol/types.py`
+- 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
 
@@ -168,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/protocol/runtime.py

@@ -1,80 +0,0 @@
-from __future__ import annotations
-
-import json
-import os
-import subprocess
-from collections.abc import Iterator
-from typing import Any
-
-from pydantic import BaseModel
-
-
-class Event(BaseModel):
-    """Protocol event envelope emitted by `codex exec --json`.
-
-    Note: `msg` is kept as a raw mapping to preserve all fields from
-    intersection types. If you need strong typing, try validating
-    against `codex.protocol.types.EventMsg` manually.
-    """
-
-    id: str
-    msg: dict[str, Any]
-
-
-def stream_exec_events(
-    prompt: str,
-    *,
-    executable: str = "codex",
-    model: str | None = None,
-    oss: bool = False,
-    full_auto: bool = False,
-    cd: str | None = None,
-    skip_git_repo_check: bool = False,
-    env: dict[str, str] | None = None,
-) -> Iterator[Event]:
-    """Spawn `codex exec --json` and yield Event objects from NDJSON stdout.
-
-    Non-event lines (config summary, prompt echo) are ignored.
-    """
-    cmd: list[str] = [executable]
-    if cd:
-        cmd += ["--cd", cd]
-    if model:
-        cmd += ["-m", model]
-    if oss:
-        cmd.append("--oss")
-    if full_auto:
-        cmd.append("--full-auto")
-    if skip_git_repo_check:
-        cmd.append("--skip-git-repo-check")
-    cmd += ["exec", "--json", prompt]
-
-    with subprocess.Popen(
-        cmd,
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
-        text=True,
-        env={**os.environ, **(env or {})},
-    ) as proc:
-        assert proc.stdout is not None
-        for line in proc.stdout:
-            line = line.strip()
-            if not line:
-                continue
-            try:
-                obj = json.loads(line)
-            except json.JSONDecodeError:
-                continue
-
-            # Filter out non-event helper lines
-            if not isinstance(obj, dict):
-                continue
-            if "id" in obj and "msg" in obj:
-                # Attempt to validate into our Pydantic Event model
-                yield Event.model_validate(obj)
-
-        # Drain stderr for diagnostics if the process failed
-        ret = proc.wait()
-        if ret != 0 and proc.stderr is not None:
-            err = proc.stderr.read()
-            raise RuntimeError(f"codex exec failed with {ret}: {err}")

codex_python-0.1.2.dist-info/RECORD

@@ -1,9 +0,0 @@
-codex/__init__.py,sha256=H12NLxWqZAOhHbkZO0rnMRhkdo_9y5DUVTmxyX2ncI0,514
-codex/api.py,sha256=gabhwkBQpdu7QdA_K75m8TPpusC9a4LteyhiZN0cI1Y,5173
-codex/protocol/runtime.py,sha256=lfnlkMYDg303Ug8awiu2FKwmbz3PGWnhTpFng-CsIe4,2229
-codex/protocol/types.py,sha256=852vSY0cdepXcu9DOJakzhsZBYpa0xF9aqBBj9GI_hE,39108
-codex/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-codex_python-0.1.2.dist-info/METADATA,sha256=swB6w-sW3820mh45KzPfoxlYBGIvAzWjN8N3efzySZg,5083
-codex_python-0.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-codex_python-0.1.2.dist-info/licenses/LICENSE,sha256=ZhGahTKhsCbPWNmZ7ugZ14LVewMo4Gh1OeIOlQabyrI,1066
-codex_python-0.1.2.dist-info/RECORD,,