codex-sdk-python 0.104.1__tar.gz → 0.114.0__tar.gz

{codex_sdk_python-0.104.1 → codex_sdk_python-0.114.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: codex-sdk-python
-Version: 0.104.1
+Version: 0.114.0
 Summary: Python SDK for the Codex CLI agent with async threads, streaming events, and structured outputs
 Keywords: codex,sdk,python,api,cli,agent,async,streaming
 Author: Vectorfy Co
@@ -18,9 +18,9 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Build Tools
-Requires-Dist: logfire ; extra == 'logfire'
+Requires-Dist: logfire-api>=4 ; extra == 'logfire'
 Requires-Dist: pydantic>=2 ; extra == 'pydantic'
-Requires-Dist: pydantic-ai ; python_full_version >= '3.10' and extra == 'pydantic-ai'
+Requires-Dist: pydantic-ai>=1.68.0,<2 ; python_full_version >= '3.10' and extra == 'pydantic-ai'
 Maintainer: Vectorfy Co
 Maintainer-email: Vectorfy Co <git@vectorfy.co>
 Requires-Python: >=3.8
@@ -44,7 +44,7 @@ Embed the Codex agent in Python workflows. This SDK wraps the bundled `codex` CL
       <td><strong>Lifecycle</strong></td>
       <td>
         <a href="#ci-cd"><img src="https://img.shields.io/badge/CI%2FCD-Active-16a34a?style=flat&logo=githubactions&logoColor=white" alt="CI/CD badge" /></a>
-        <img src="https://img.shields.io/badge/Release-0.104.1-6b7280?style=flat&logo=pypi&logoColor=white" alt="Release 0.104.1 badge" />
+        <img src="https://img.shields.io/badge/Release-0.114.0-6b7280?style=flat&logo=pypi&logoColor=white" alt="Release badge" />
         <a href="#license"><img src="https://img.shields.io/badge/License-Apache--2.0-0f766e?style=flat&logo=apache&logoColor=white" alt="License badge" /></a>
       </td>
     </tr>
@@ -347,15 +347,20 @@ default prompt) for richer UI integrations.
 The SDK also exposes helpers for most app-server endpoints:
 
 - Threads: `thread_start`, `thread_resume`, `thread_fork`, `thread_list`, `thread_loaded_list`,
-  `thread_read`, `thread_archive`, `thread_unarchive`, `thread_name_set`,
-  `thread_compact_start`, `thread_rollback`
+  `thread_read`, `thread_archive`, `thread_unsubscribe`, `thread_unarchive`,
+  `thread_name_set`, `thread_compact_start`, `thread_rollback`, `thread_metadata_update`
 - Config: `config_read`, `config_value_write`, `config_batch_write`, `config_requirements_read`
-- Skills: `skills_list`, `skills_remote_read`, `skills_remote_write`, `skills_config_write`
-- Turns/review: `turn_start`, `turn_interrupt`, `review_start`, `turn_session`
-- Models: `model_list`
+- Skills: `skills_list`, `skills_remote_list`, `skills_remote_export`, `skills_remote_read` (alias),
+  `skills_remote_write` (alias), `skills_config_write`
+- Turns/review: `turn_start`, `turn_steer`, `turn_interrupt`, `review_start`, `turn_session`
+- Models: `model_list`, `experimental_feature_list`
 - Collaboration modes: `collaboration_mode_list` (experimental)
-- One-off commands: `command_exec`
+- Plugins: `plugin_list`, `plugin_install`, `plugin_uninstall`
+- One-off commands: `command_exec`, `command_exec_write`, `command_exec_resize`,
+  `command_exec_terminate`
 - MCP auth/status: `mcp_server_oauth_login`, `mcp_server_refresh`, `mcp_server_status_list`
+- External agent config: `external_agent_config_detect`, `external_agent_config_import`
+- Windows sandbox: `windows_sandbox_setup_start`
 - Account: `account_login_start`, `account_login_cancel`, `account_logout`,
   `account_rate_limits_read`, `account_read`
 - Feedback: `feedback_upload`
@@ -366,21 +371,11 @@ for payload shapes and event semantics.
 Note: some endpoints and fields are gated behind an experimental capability; set
 `AppServerOptions(experimental_api_enabled=True)` to opt in.
 
-`thread_list` supports `archived`, `sort_key`, and `source_kinds` filters (unchanged), and now also accepts `cwd`
-for scoped thread queries. `config_read` accepts an optional `cwd` to compute effective layered config for a specific
-working directory.
+`ApprovalDecisions` also supports `permissions_request` for auto-responding to
+`item/permissions/requestApproval` server requests during `turn_session()`.
 
-`skills_remote_read` supports `cwds`, `enabled`, `hazelnut_scope`, and `product_surface` filters. `model_list` accepts
-an optional `include_hidden` flag.
-
-```python
-threads = await app.thread_list(archived=False, sort_key="updatedAt", source_kinds=["local"], cwd=".")
-config = await app.config_read(include_layers=True, cwd=".")
-skills = await app.skills_remote_read(
-    cwds=["."], enabled=True, hazelnut_scope="user", product_surface="codex_desktop"
-)
-models = await app.model_list(limit=20, include_hidden=False)
-```
+`thread_list` supports `archived`, `sort_key`, and `source_kinds` filters, and `config_read` accepts an optional `cwd`
+to compute the effective layered config for a specific working directory.
 
 ### Observability (OTEL) and notify
 
@@ -423,9 +418,8 @@ Supported target triples:
 - macOS: `x86_64-apple-darwin`, `aarch64-apple-darwin`
 - Windows: `x86_64-pc-windows-msvc`, `aarch64-pc-windows-msvc`
 
-If you are working from source and the vendor directory is missing, run
-`python scripts/setup_binary.py` to fetch and assemble the platform `@openai/codex`
-artifacts into `src/codex_sdk/vendor/`.
+If you are working from source and the vendor directory is missing, run `python scripts/setup_binary.py`
+or follow `SETUP.md` to download the official npm package and copy the `vendor/` directory.
 
 <a id="auth"></a>
 ## ![Auth](https://img.shields.io/badge/Auth%20%26%20Credentials-Access-2563eb?style=for-the-badge&logo=gnubash&logoColor=white)
@@ -518,6 +512,7 @@ print(turn.final_response)
 - `command_execution`
 - `file_change`
 - `mcp_tool_call`
+- `collab_tool_call`
 - `web_search`
 - `todo_list`
 - `error`
@@ -594,7 +589,8 @@ last_thread = codex.resume_last_thread()
 ### Turn helpers
 
 Each `Turn` provides convenience filters: `agent_messages()`, `reasoning()`, `commands()`,
-`file_changes()`, `mcp_tool_calls()`, `web_searches()`, `todo_lists()`, and `errors()`.
+`file_changes()`, `mcp_tool_calls()`, `collab_tool_calls()`, `web_searches()`,
+`todo_lists()`, and `errors()`.
 
 <a id="api"></a>
 ## ![API Reference](https://img.shields.io/badge/API-Reference-6366f1?style=for-the-badge&logo=python&logoColor=white)
@@ -615,7 +611,12 @@ Exceptions:
 Typed events and items:
 - `ThreadEvent` union of `thread.*`, `turn.*`, `item.*`, and `error` events.
 - `ThreadItem` union of `agent_message`, `reasoning`, `command_execution`, `file_change`,
-  `mcp_tool_call`, `web_search`, `todo_list`, `error`.
+  `mcp_tool_call`, `collab_tool_call`, `web_search`, `todo_list`, `error`.
+- `CollabToolCallItem`: typed item for `collab_tool_call` thread history entries.
+- `CollabToolCallStatus`: typed status values for collaboration tool calls.
+- `CollabTool`: collaboration tool metadata attached to `CollabToolCallItem`.
+- `CollabAgentStatus`: agent lifecycle status attached to collaboration state updates.
+- `CollabAgentState`: agent metadata/state payload emitted for collaboration items.
 
 <a id="examples"></a>
 ## ![Examples](https://img.shields.io/badge/Examples-Reference%20Scripts-6366f1?style=for-the-badge&logo=python&logoColor=white)
@@ -632,6 +633,7 @@ Example scripts under `examples/`:
 - `hooks_streaming.py`: event hooks for streaming runs.
 - `notify_hook.py`: notify script for CLI callbacks.
 - `pydantic_ai_model_provider.py`: Codex as a PydanticAI model provider.
+- `pydantic_ai_model_provider_streaming.py`: live PydanticAI text streaming over `CodexModel`.
 - `pydantic_ai_handoff.py`: Codex as a PydanticAI tool.
 
 <a id="sandbox"></a>
@@ -681,12 +683,30 @@ result = agent.run_sync("What's 19 + 23? Use the add tool.")
 print(result.output)
 ```
 
+For live text streaming in a terminal or web UI:
+
+```python
+from pydantic_ai import Agent
+
+from codex_sdk.integrations.pydantic_ai_model import CodexModel
+
+agent = Agent(CodexModel(), output_type=str)
+
+async with agent.run_stream("Explain why the sky is blue.") as result:
+    async for delta in result.stream_text(delta=True, debounce_by=None):
+        print(delta, end="", flush=True)
+```
+
 How it works:
 - `CodexModel` builds a JSON schema envelope with `tool_calls` and `final`.
 - Codex emits tool calls as JSON strings; PydanticAI runs them.
 - If `allow_text_output` is true, Codex can place final text in `final`.
-- Streaming APIs (`Agent.run_stream_events()`, `Agent.run_stream_sync()`) are supported; Codex
-  emits streamed responses as a single chunk once the turn completes.
+- This SDK targets the current PydanticAI release line (`>=1.68.0,<2`).
+- `Agent.run_stream()`, `Agent.run_stream_events()`, and `Agent.run_stream_sync()`
+  work with `CodexModel`.
+- Text deltas are forwarded live from agent-message updates when Codex emits them, including
+  envelope-backed `final` text. Tool calls are forwarded as soon as Codex produces a valid
+  envelope update, and `streamed.get()` is reconciled to the canonical final turn result.
 
 Safety defaults (you can override with your own `ThreadOptions`):
 - `sandbox_mode="read-only"`

{codex_sdk_python-0.104.1 → codex_sdk_python-0.114.0}/README.md

@@ -8,7 +8,7 @@ Embed the Codex agent in Python workflows. This SDK wraps the bundled `codex` CL
       <td><strong>Lifecycle</strong></td>
       <td>
         <a href="#ci-cd"><img src="https://img.shields.io/badge/CI%2FCD-Active-16a34a?style=flat&logo=githubactions&logoColor=white" alt="CI/CD badge" /></a>
-        <img src="https://img.shields.io/badge/Release-0.104.1-6b7280?style=flat&logo=pypi&logoColor=white" alt="Release 0.104.1 badge" />
+        <img src="https://img.shields.io/badge/Release-0.114.0-6b7280?style=flat&logo=pypi&logoColor=white" alt="Release badge" />
         <a href="#license"><img src="https://img.shields.io/badge/License-Apache--2.0-0f766e?style=flat&logo=apache&logoColor=white" alt="License badge" /></a>
       </td>
     </tr>
@@ -311,15 +311,20 @@ default prompt) for richer UI integrations.
 The SDK also exposes helpers for most app-server endpoints:
 
 - Threads: `thread_start`, `thread_resume`, `thread_fork`, `thread_list`, `thread_loaded_list`,
-  `thread_read`, `thread_archive`, `thread_unarchive`, `thread_name_set`,
-  `thread_compact_start`, `thread_rollback`
+  `thread_read`, `thread_archive`, `thread_unsubscribe`, `thread_unarchive`,
+  `thread_name_set`, `thread_compact_start`, `thread_rollback`, `thread_metadata_update`
 - Config: `config_read`, `config_value_write`, `config_batch_write`, `config_requirements_read`
-- Skills: `skills_list`, `skills_remote_read`, `skills_remote_write`, `skills_config_write`
-- Turns/review: `turn_start`, `turn_interrupt`, `review_start`, `turn_session`
-- Models: `model_list`
+- Skills: `skills_list`, `skills_remote_list`, `skills_remote_export`, `skills_remote_read` (alias),
+  `skills_remote_write` (alias), `skills_config_write`
+- Turns/review: `turn_start`, `turn_steer`, `turn_interrupt`, `review_start`, `turn_session`
+- Models: `model_list`, `experimental_feature_list`
 - Collaboration modes: `collaboration_mode_list` (experimental)
-- One-off commands: `command_exec`
+- Plugins: `plugin_list`, `plugin_install`, `plugin_uninstall`
+- One-off commands: `command_exec`, `command_exec_write`, `command_exec_resize`,
+  `command_exec_terminate`
 - MCP auth/status: `mcp_server_oauth_login`, `mcp_server_refresh`, `mcp_server_status_list`
+- External agent config: `external_agent_config_detect`, `external_agent_config_import`
+- Windows sandbox: `windows_sandbox_setup_start`
 - Account: `account_login_start`, `account_login_cancel`, `account_logout`,
   `account_rate_limits_read`, `account_read`
 - Feedback: `feedback_upload`
@@ -330,21 +335,11 @@ for payload shapes and event semantics.
 Note: some endpoints and fields are gated behind an experimental capability; set
 `AppServerOptions(experimental_api_enabled=True)` to opt in.
 
-`thread_list` supports `archived`, `sort_key`, and `source_kinds` filters (unchanged), and now also accepts `cwd`
-for scoped thread queries. `config_read` accepts an optional `cwd` to compute effective layered config for a specific
-working directory.
+`ApprovalDecisions` also supports `permissions_request` for auto-responding to
+`item/permissions/requestApproval` server requests during `turn_session()`.
 
-`skills_remote_read` supports `cwds`, `enabled`, `hazelnut_scope`, and `product_surface` filters. `model_list` accepts
-an optional `include_hidden` flag.
-
-```python
-threads = await app.thread_list(archived=False, sort_key="updatedAt", source_kinds=["local"], cwd=".")
-config = await app.config_read(include_layers=True, cwd=".")
-skills = await app.skills_remote_read(
-    cwds=["."], enabled=True, hazelnut_scope="user", product_surface="codex_desktop"
-)
-models = await app.model_list(limit=20, include_hidden=False)
-```
+`thread_list` supports `archived`, `sort_key`, and `source_kinds` filters, and `config_read` accepts an optional `cwd`
+to compute the effective layered config for a specific working directory.
 
 ### Observability (OTEL) and notify
 
@@ -387,9 +382,8 @@ Supported target triples:
 - macOS: `x86_64-apple-darwin`, `aarch64-apple-darwin`
 - Windows: `x86_64-pc-windows-msvc`, `aarch64-pc-windows-msvc`
 
-If you are working from source and the vendor directory is missing, run
-`python scripts/setup_binary.py` to fetch and assemble the platform `@openai/codex`
-artifacts into `src/codex_sdk/vendor/`.
+If you are working from source and the vendor directory is missing, run `python scripts/setup_binary.py`
+or follow `SETUP.md` to download the official npm package and copy the `vendor/` directory.
 
 <a id="auth"></a>
 ## ![Auth](https://img.shields.io/badge/Auth%20%26%20Credentials-Access-2563eb?style=for-the-badge&logo=gnubash&logoColor=white)
@@ -482,6 +476,7 @@ print(turn.final_response)
 - `command_execution`
 - `file_change`
 - `mcp_tool_call`
+- `collab_tool_call`
 - `web_search`
 - `todo_list`
 - `error`
@@ -558,7 +553,8 @@ last_thread = codex.resume_last_thread()
 ### Turn helpers
 
 Each `Turn` provides convenience filters: `agent_messages()`, `reasoning()`, `commands()`,
-`file_changes()`, `mcp_tool_calls()`, `web_searches()`, `todo_lists()`, and `errors()`.
+`file_changes()`, `mcp_tool_calls()`, `collab_tool_calls()`, `web_searches()`,
+`todo_lists()`, and `errors()`.
 
 <a id="api"></a>
 ## ![API Reference](https://img.shields.io/badge/API-Reference-6366f1?style=for-the-badge&logo=python&logoColor=white)
@@ -579,7 +575,12 @@ Exceptions:
 Typed events and items:
 - `ThreadEvent` union of `thread.*`, `turn.*`, `item.*`, and `error` events.
 - `ThreadItem` union of `agent_message`, `reasoning`, `command_execution`, `file_change`,
-  `mcp_tool_call`, `web_search`, `todo_list`, `error`.
+  `mcp_tool_call`, `collab_tool_call`, `web_search`, `todo_list`, `error`.
+- `CollabToolCallItem`: typed item for `collab_tool_call` thread history entries.
+- `CollabToolCallStatus`: typed status values for collaboration tool calls.
+- `CollabTool`: collaboration tool metadata attached to `CollabToolCallItem`.
+- `CollabAgentStatus`: agent lifecycle status attached to collaboration state updates.
+- `CollabAgentState`: agent metadata/state payload emitted for collaboration items.
 
 <a id="examples"></a>
 ## ![Examples](https://img.shields.io/badge/Examples-Reference%20Scripts-6366f1?style=for-the-badge&logo=python&logoColor=white)
@@ -596,6 +597,7 @@ Example scripts under `examples/`:
 - `hooks_streaming.py`: event hooks for streaming runs.
 - `notify_hook.py`: notify script for CLI callbacks.
 - `pydantic_ai_model_provider.py`: Codex as a PydanticAI model provider.
+- `pydantic_ai_model_provider_streaming.py`: live PydanticAI text streaming over `CodexModel`.
 - `pydantic_ai_handoff.py`: Codex as a PydanticAI tool.
 
 <a id="sandbox"></a>
@@ -645,12 +647,30 @@ result = agent.run_sync("What's 19 + 23? Use the add tool.")
 print(result.output)
 ```
 
+For live text streaming in a terminal or web UI:
+
+```python
+from pydantic_ai import Agent
+
+from codex_sdk.integrations.pydantic_ai_model import CodexModel
+
+agent = Agent(CodexModel(), output_type=str)
+
+async with agent.run_stream("Explain why the sky is blue.") as result:
+    async for delta in result.stream_text(delta=True, debounce_by=None):
+        print(delta, end="", flush=True)
+```
+
 How it works:
 - `CodexModel` builds a JSON schema envelope with `tool_calls` and `final`.
 - Codex emits tool calls as JSON strings; PydanticAI runs them.
 - If `allow_text_output` is true, Codex can place final text in `final`.
-- Streaming APIs (`Agent.run_stream_events()`, `Agent.run_stream_sync()`) are supported; Codex
-  emits streamed responses as a single chunk once the turn completes.
+- This SDK targets the current PydanticAI release line (`>=1.68.0,<2`).
+- `Agent.run_stream()`, `Agent.run_stream_events()`, and `Agent.run_stream_sync()`
+  work with `CodexModel`.
+- Text deltas are forwarded live from agent-message updates when Codex emits them, including
+  envelope-backed `final` text. Tool calls are forwarded as soon as Codex produces a valid
+  envelope update, and `streamed.get()` is reconciled to the canonical final turn result.
 
 Safety defaults (you can override with your own `ThreadOptions`):
 - `sandbox_mode="read-only"`

{codex_sdk_python-0.104.1 → codex_sdk_python-0.114.0}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["uv_build>=0.9.21,<0.11.0"]
+requires = ["uv_build>=0.9.21,<0.10.0"]
 build-backend = "uv_build"
 
 [project]
 name = "codex-sdk-python"
-version = "0.104.1"
+version = "0.114.0"
 description = "Python SDK for the Codex CLI agent with async threads, streaming events, and structured outputs"
 readme = "README.md"
 license = {text = "Apache-2.0"}
@@ -37,10 +37,13 @@ pydantic = [
     "pydantic>=2",
 ]
 pydantic-ai = [
-    "pydantic-ai; python_version >= '3.10'",
+    "pydantic-ai>=1.68.0,<2; python_version >= '3.10'",
 ]
 logfire = [
-    "logfire",
+    # `pydantic-ai` imports the `logfire` module, which is provided by the
+    # `logfire-api` distribution. Avoid the unrelated legacy `logfire` package
+    # on PyPI which can shadow it and break imports.
+    "logfire-api>=4",
 ]
 
 [dependency-groups]
@@ -49,7 +52,7 @@ dev = [
     "pytest-asyncio>=0.21.0",
     "pytest-cov>=4.0",
     "pydantic>=2",
-    "pydantic-ai; python_version >= '3.10'",
+    "pydantic-ai>=1.68.0,<2; python_version >= '3.10'",
     "black>=22.0",
     "isort>=5.0",
     "mypy>=1.0",

{codex_sdk_python-0.104.1 → codex_sdk_python-0.114.0}/src/codex_sdk/__init__.py

@@ -15,8 +15,6 @@ from .app_server import (
     AppServerRequest,
     AppServerTurnSession,
     AppServerUserInput,
-    SkillsRemoteReadRequest,
-    SkillsRemoteWriteRequest,
 )
 from .codex import Codex
 from .events import (
@@ -43,6 +41,11 @@ from .exceptions import (
 from .hooks import ThreadHooks
 from .items import (
     AgentMessageItem,
+    CollabAgentState,
+    CollabAgentStatus,
+    CollabTool,
+    CollabToolCallItem,
+    CollabToolCallStatus,
     CommandExecutionItem,
     CommandExecutionStatus,
     ErrorItem,
@@ -79,7 +82,7 @@ from .thread import (
     Turn,
 )
 
-__version__ = "0.104.1"
+__version__ = "0.114.0"
 
 __all__ = [
     "AbortController",
@@ -94,8 +97,6 @@ __all__ = [
     "ApprovalDecisions",
     "AppServerInput",
     "AppServerUserInput",
-    "SkillsRemoteReadRequest",
-    "SkillsRemoteWriteRequest",
     "Thread",
     "ThreadHooks",
     "Input",
@@ -121,6 +122,7 @@ __all__ = [
     "CommandExecutionItem",
     "FileChangeItem",
     "McpToolCallItem",
+    "CollabToolCallItem",
     "McpToolCallItemResult",
     "McpToolCallItemError",
     "WebSearchItem",
@@ -130,6 +132,10 @@ __all__ = [
     "PatchChangeKind",
     "PatchApplyStatus",
     "McpToolCallStatus",
+    "CollabToolCallStatus",
+    "CollabTool",
+    "CollabAgentStatus",
+    "CollabAgentState",
     "TodoItem",
     "CodexOptions",
     "ThreadOptions",