codex-sdk-python 0.89.0__tar.gz → 0.98.0__tar.gz

{codex_sdk_python-0.89.0 → codex_sdk_python-0.98.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: codex-sdk-python
-Version: 0.89.0
+Version: 0.98.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,7 +18,7 @@ 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'
 Maintainer: Vectorfy Co
@@ -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.86.0-6b7280?style=flat&logo=pypi&logoColor=white" alt="Release badge" />
+        <img src="https://img.shields.io/badge/Release-0.98.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>
@@ -89,7 +89,7 @@ uv add codex-sdk-python
 2. Ensure a `codex` binary is available (required for local runs):
 
 ```bash
-# From the repo source (downloads vendor binaries)
+# From the repo source (downloads vendor binaries from the matching npm release)
 python scripts/setup_binary.py
 ```
 
@@ -255,6 +255,7 @@ ThreadOptions(
     exec_policy_enabled=True,
     remote_models_enabled=False,
     collaboration_modes_enabled=True,
+    connectors_enabled=True,
     responses_websockets_enabled=True,
     request_compression_enabled=True,
     approval_policy="on-request",
@@ -282,6 +283,7 @@ Important mappings to the Codex CLI:
 - `exec_policy_enabled` maps to `--config features.exec_policy=...`.
 - `remote_models_enabled` maps to `--config features.remote_models=...`.
 - `collaboration_modes_enabled` maps to `--config features.collaboration_modes=...`.
+- `connectors_enabled` maps to `--config features.connectors=...`.
 - `responses_websockets_enabled` maps to `--config features.responses_websockets=...`.
 - `request_compression_enabled` maps to `--config features.enable_request_compression=...`.
 - `feature_overrides` maps to `--config features.<key>=...` (explicit options take precedence).
@@ -289,6 +291,7 @@ Important mappings to the Codex CLI:
 - `config_overrides` maps to repeated `--config key=value` entries.
 
 Note: `skills_enabled` is deprecated in Codex 0.80+ (skills are always enabled).
+Note: Codex defaults `agents.max_threads` to 6; `max_threads` must be `>= 1` if set.
 Note: Codex 0.88.0+ ignores `experimental_instructions_file`; use
 `model_instructions_file` instead.
 
@@ -343,12 +346,14 @@ default prompt) for richer UI integrations.
 
 The SDK also exposes helpers for most app-server endpoints:
 
-- Threads: `thread_list`, `thread_read`, `thread_archive`, `thread_rollback`, `thread_loaded_list`
+- 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`
 - Config: `config_read`, `config_value_write`, `config_batch_write`, `config_requirements_read`
-- Skills: `skills_list`
+- 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`
-- Collaboration modes: `collaboration_mode_list`
+- Collaboration modes: `collaboration_mode_list` (experimental)
 - One-off commands: `command_exec`
 - MCP auth/status: `mcp_server_oauth_login`, `mcp_server_refresh`, `mcp_server_status_list`
 - Account: `account_login_start`, `account_login_cancel`, `account_logout`,
@@ -358,7 +363,10 @@ The SDK also exposes helpers for most app-server endpoints:
 These map 1:1 to the Codex app-server protocol; see `codex/codex-rs/app-server/README.md`
 for payload shapes and event semantics.
 
-`thread_list` supports an `archived` filter, and `config_read` accepts an optional `cwd`
+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, and `config_read` accepts an optional `cwd`
 to compute the effective layered config for a specific working directory.
 
 ### Observability (OTEL) and notify

{codex_sdk_python-0.89.0 → codex_sdk_python-0.98.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.86.0-6b7280?style=flat&logo=pypi&logoColor=white" alt="Release badge" />
+        <img src="https://img.shields.io/badge/Release-0.98.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>
@@ -53,7 +53,7 @@ uv add codex-sdk-python
 2. Ensure a `codex` binary is available (required for local runs):
 
 ```bash
-# From the repo source (downloads vendor binaries)
+# From the repo source (downloads vendor binaries from the matching npm release)
 python scripts/setup_binary.py
 ```
 
@@ -219,6 +219,7 @@ ThreadOptions(
     exec_policy_enabled=True,
     remote_models_enabled=False,
     collaboration_modes_enabled=True,
+    connectors_enabled=True,
     responses_websockets_enabled=True,
     request_compression_enabled=True,
     approval_policy="on-request",
@@ -246,6 +247,7 @@ Important mappings to the Codex CLI:
 - `exec_policy_enabled` maps to `--config features.exec_policy=...`.
 - `remote_models_enabled` maps to `--config features.remote_models=...`.
 - `collaboration_modes_enabled` maps to `--config features.collaboration_modes=...`.
+- `connectors_enabled` maps to `--config features.connectors=...`.
 - `responses_websockets_enabled` maps to `--config features.responses_websockets=...`.
 - `request_compression_enabled` maps to `--config features.enable_request_compression=...`.
 - `feature_overrides` maps to `--config features.<key>=...` (explicit options take precedence).
@@ -253,6 +255,7 @@ Important mappings to the Codex CLI:
 - `config_overrides` maps to repeated `--config key=value` entries.
 
 Note: `skills_enabled` is deprecated in Codex 0.80+ (skills are always enabled).
+Note: Codex defaults `agents.max_threads` to 6; `max_threads` must be `>= 1` if set.
 Note: Codex 0.88.0+ ignores `experimental_instructions_file`; use
 `model_instructions_file` instead.
 
@@ -307,12 +310,14 @@ default prompt) for richer UI integrations.
 
 The SDK also exposes helpers for most app-server endpoints:
 
-- Threads: `thread_list`, `thread_read`, `thread_archive`, `thread_rollback`, `thread_loaded_list`
+- 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`
 - Config: `config_read`, `config_value_write`, `config_batch_write`, `config_requirements_read`
-- Skills: `skills_list`
+- 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`
-- Collaboration modes: `collaboration_mode_list`
+- Collaboration modes: `collaboration_mode_list` (experimental)
 - One-off commands: `command_exec`
 - MCP auth/status: `mcp_server_oauth_login`, `mcp_server_refresh`, `mcp_server_status_list`
 - Account: `account_login_start`, `account_login_cancel`, `account_logout`,
@@ -322,7 +327,10 @@ The SDK also exposes helpers for most app-server endpoints:
 These map 1:1 to the Codex app-server protocol; see `codex/codex-rs/app-server/README.md`
 for payload shapes and event semantics.
 
-`thread_list` supports an `archived` filter, and `config_read` accepts an optional `cwd`
+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, and `config_read` accepts an optional `cwd`
 to compute the effective layered config for a specific working directory.
 
 ### Observability (OTEL) and notify

{codex_sdk_python-0.89.0 → codex_sdk_python-0.98.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "codex-sdk-python"
-version = "0.89.0"
+version = "0.98.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"}
@@ -40,7 +40,10 @@ pydantic-ai = [
     "pydantic-ai; 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]

{codex_sdk_python-0.89.0 → codex_sdk_python-0.98.0}/src/codex_sdk/__init__.py

@@ -41,6 +41,11 @@ from .exceptions import (
 from .hooks import ThreadHooks
 from .items import (
     AgentMessageItem,
+    CollabAgentState,
+    CollabAgentStatus,
+    CollabTool,
+    CollabToolCallItem,
+    CollabToolCallStatus,
     CommandExecutionItem,
     CommandExecutionStatus,
     ErrorItem,
@@ -77,7 +82,7 @@ from .thread import (
     Turn,
 )
 
-__version__ = "0.89.0"
+__version__ = "0.98.0"
 
 __all__ = [
     "AbortController",
@@ -117,6 +122,7 @@ __all__ = [
     "CommandExecutionItem",
     "FileChangeItem",
     "McpToolCallItem",
+    "CollabToolCallItem",
     "McpToolCallItemResult",
     "McpToolCallItemError",
     "WebSearchItem",
@@ -126,6 +132,10 @@ __all__ = [
     "PatchChangeKind",
     "PatchApplyStatus",
     "McpToolCallStatus",
+    "CollabToolCallStatus",
+    "CollabTool",
+    "CollabAgentStatus",
+    "CollabAgentState",
     "TodoItem",
     "CodexOptions",
     "ThreadOptions",

{codex_sdk_python-0.89.0 → codex_sdk_python-0.98.0}/src/codex_sdk/abort.py

@@ -18,13 +18,16 @@ class AbortSignal:
 
     @property
     def aborted(self) -> bool:
+        """Return True if the signal has been aborted."""
         return self._event.is_set()
 
     @property
     def reason(self) -> Optional[AbortReason]:
+        """Return the abort reason if provided."""
         return self._reason
 
     async def wait(self) -> None:
+        """Wait until the signal is aborted."""
         await self._event.wait()
 
 
@@ -32,9 +35,15 @@ class AbortController:
     """Controller used to trigger cancellation for an AbortSignal."""
 
     def __init__(self) -> None:
+        """Create a controller with a fresh AbortSignal."""
         self._event = asyncio.Event()
         self.signal = AbortSignal(self._event)
 
     def abort(self, reason: Optional[AbortReason] = None) -> None:
+        """Abort the signal and optionally attach a reason.
+
+        Args:
+            reason: Optional abort reason to surface to callers.
+        """
         self.signal._reason = reason
         self._event.set()