codex-python 0.1.1__tar.gz → 0.1.2__tar.gz

{codex_python-0.1.1 → codex_python-0.1.2}/.gitignore

@@ -44,6 +44,13 @@ coverage.xml
 .uv/
 uv.lock
 
+# Generated artifacts
+# Generated artifacts
+.generated/
+
+# Ignore new markdown files by default
+*.md
+
 # Local environment files
 .env
 .env.*

{codex_python-0.1.1 → codex_python-0.1.2}/Makefile

@@ -7,6 +7,7 @@ help:
 	@echo "  make build    - Build sdist and wheel with uv"
 	@echo "  make publish  - Publish to PyPI via uv (uses PYPI_API_TOKEN)"
 	@echo "  make clean    - Remove build artifacts"
+	@echo "  make gen-protocol - Generate Python protocol bindings from codex-rs"
 
 venv:
 	uv venv --python 3.13
@@ -16,8 +17,8 @@ fmt:
 	uv run --group dev ruff format .
 
 lint:
-	uv run --group dev ruff format --check .
-	uv run --group dev ruff check .
+	uv run --group dev ruff format .
+	uv run --group dev ruff check --fix --unsafe-fixes .
 	uv run --group dev mypy codex
 
 test:
@@ -49,3 +50,17 @@ publish: build
 
 clean:
 	rm -rf build dist *.egg-info .pytest_cache .mypy_cache .ruff_cache
+
+gen-protocol:
+	@echo "Generating TypeScript protocol types via codex-proj/codex-rs ..."
+	@mkdir -p .generated/ts
+	@if command -v codex >/dev/null 2>&1; then \
+		echo "Using 'codex generate-types'"; \
+		codex generate-types --out .generated/ts; \
+	else \
+		echo "Using cargo run -p codex-protocol-ts"; \
+		cd codex-proj/codex-rs && cargo run -p codex-protocol-ts -- --out ../../.generated/ts; \
+	fi
+	@echo "Generating Python bindings ..."
+	@python3 scripts/generate_protocol_py.py .generated/ts
+	@$(MAKE) fmt

{codex_python-0.1.1 → codex_python-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codex-python
-Version: 0.1.1
+Version: 0.1.2
 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,6 +36,7 @@ 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
@@ -70,6 +71,18 @@ Options:
 - Full auto: `run_exec("scaffold a cli", full_auto=True)`
 - Run in another dir: `run_exec("...", cd="/path/to/project")`
 
+Streaming JSON events (no PyO3 required):
+
+```
+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:
 
 ```
@@ -125,6 +138,19 @@ 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:
+- 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`
+
 ## Project Layout
 
 ```

{codex_python-0.1.1 → codex_python-0.1.2}/README.md

@@ -30,6 +30,18 @@ Options:
 - Full auto: `run_exec("scaffold a cli", full_auto=True)`
 - Run in another dir: `run_exec("...", cd="/path/to/project")`
 
+Streaming JSON events (no PyO3 required):
+
+```
+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:
 
 ```
@@ -85,6 +97,19 @@ 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:
+- 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`
+
 ## Project Layout
 
 ```

{codex_python-0.1.1 → codex_python-0.1.2}/codex/__init__.py

@@ -27,4 +27,4 @@ __all__ = [
 ]
 
 # Managed by Hatch via pyproject.toml [tool.hatch.version]
-__version__ = "0.1.1"
+__version__ = "0.1.2"

{codex_python-0.1.1 → codex_python-0.1.2}/codex/api.py

@@ -51,12 +51,15 @@ def run_exec(
     prompt: str,
     *,
     model: str | None = None,
+    oss: bool = False,
     full_auto: bool = False,
     cd: str | None = None,
+    skip_git_repo_check: bool = False,
     timeout: float | None = None,
     env: Mapping[str, str] | None = None,
     executable: str = "codex",
     extra_args: Iterable[str] | None = None,
+    json: bool = False,
 ) -> str:
     """
     Run `codex exec` with the given prompt and return stdout as text.
@@ -72,12 +75,19 @@ def run_exec(
         cmd.extend(["--cd", cd])
     if model:
         cmd.extend(["-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")
     if extra_args:
         cmd.extend(list(extra_args))
 
-    cmd.extend(["exec", prompt])
+    cmd.append("exec")
+    if json:
+        cmd.append("--json")
+    cmd.append(prompt)
 
     completed = subprocess.run(
         cmd,
@@ -123,8 +133,10 @@ class CodexClient:
         prompt: str,
         *,
         model: str | None = None,
+        oss: bool | None = None,
         full_auto: bool | None = None,
         cd: str | None = None,
+        skip_git_repo_check: bool | None = None,
         timeout: float | None = None,
         env: Mapping[str, str] | None = None,
         extra_args: Iterable[str] | None = None,
@@ -136,6 +148,8 @@ class CodexClient:
         eff_model = model if model is not None else self.model
         eff_full_auto = full_auto if full_auto is not None else self.full_auto
         eff_cd = cd if cd is not None else self.cd
+        eff_oss = bool(oss) if oss is not None else False
+        eff_skip_git = bool(skip_git_repo_check) if skip_git_repo_check is not None else False
 
         # Merge environment overlays; run_exec will merge with os.environ
         merged_env: Mapping[str, str] | None
@@ -156,8 +170,10 @@ class CodexClient:
         return run_exec(
             prompt,
             model=eff_model,
+            oss=eff_oss,
             full_auto=eff_full_auto,
             cd=eff_cd,
+            skip_git_repo_check=eff_skip_git,
             timeout=timeout,
             env=merged_env,
             executable=self.executable,

codex_python-0.1.2/codex/protocol/runtime.py

@@ -0,0 +1,80 @@
+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}")