toolplane-python-client 0.1.0__py3-none-any.whl

toolplane_python_client-0.1.0.dist-info/METADATA

@@ -0,0 +1,543 @@
+Metadata-Version: 2.4
+Name: toolplane-python-client
+Version: 0.1.0
+Summary: Python client for the Toolplane control plane
+Author-email: Abhishek Chohan <54611095+Abhishek-chohan@users.noreply.github.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Abhishek-chohan/tool-control-plane
+Project-URL: Repository, https://github.com/Abhishek-chohan/tool-control-plane
+Project-URL: Bug Tracker, https://github.com/Abhishek-chohan/tool-control-plane/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: grpcio>=1.80.0
+Requires-Dist: grpcio-tools>=1.80.0
+Requires-Dist: protobuf<7.0.0,>=6.31.1
+Requires-Dist: googleapis-common-protos>=1.63.0
+Requires-Dist: requests>=2.25.0
+Requires-Dist: typing-extensions>=4.0.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.10.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: flake8-docstrings>=1.7.0; extra == "dev"
+Requires-Dist: flake8-builtins>=2.0.0; extra == "dev"
+Requires-Dist: flake8-annotations>=3.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: coverage>=7.0.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Requires-Dist: mkdocs>=1.4.0; extra == "dev"
+Requires-Dist: mkdocs-material>=9.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.4.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.20.0; extra == "docs"
+Provides-Extra: lint
+Requires-Dist: black>=23.0.0; extra == "lint"
+Requires-Dist: isort>=5.10.0; extra == "lint"
+Requires-Dist: mypy>=1.0.0; extra == "lint"
+Requires-Dist: flake8>=6.0.0; extra == "lint"
+Requires-Dist: flake8-docstrings>=1.7.0; extra == "lint"
+Requires-Dist: flake8-builtins>=2.0.0; extra == "lint"
+Requires-Dist: flake8-annotations>=3.0.0; extra == "lint"
+
+# Toolplane Python Client
+
+The Python package is the primary maintained SDK for Toolplane's durable remote tool-execution control plane. Python is the richest current client surface and the baseline for the repo's end-to-end provider, consumer, and admin capability.
+
+## Decision Rule
+
+Use Toolplane when one remote tool may outlive the caller, needs inspection or bounded replay after disconnect, needs explicit provider ownership or drain behavior, or is queue-backed enough that request lifecycle control matters. If the work is quick, in-process, same-lifecycle, and not operationally sensitive, direct tool calling is simpler.
+
+A concrete first offload candidate is one sandboxed code-execution worker. The Python provider-consumer path is the maintained starting point for that shape because it covers explicit provider ownership, request lifecycle control, and the maintained HTTP gateway compatibility layer on the richest SDK surface.
+
+## Support Status
+
+- Primary maintained SDK and current completeness baseline.
+- gRPC is the primary transport for the repo's control-plane story.
+- `ToolplaneHTTP` is a maintained compatibility surface over the same session, tool, machine, request, and task flows.
+- Python exposes a broader public surface than the current Go and TypeScript SDKs; confirm cross-SDK portability in [SDK_MAP.md](../../SDK_MAP.md) before assuming parity.
+
+## First Offload Path
+
+Start with the maintained provider-consumer pair before exploring the full API. The sample tools are intentionally simple, but this is the same lifecycle you would reuse to offload one sandboxed code-execution tool or another environment-bound worker:
+
+1. Run `example_client.py` — connects via gRPC, creates a session through the explicit `ProviderRuntime`, registers machine-backed tools, and starts the provider loop.
+2. Copy the printed `TOOLPLANE_SESSION_ID`.
+3. Run `example_user.py` with that session ID — lists tools, invokes provider-backed work, and polls request state.
+
+See [README_EXAMPLES.md](README_EXAMPLES.md) for environment defaults and the full example flow. For runtime semantics — request lifecycle, streaming, recovery windows, machine drain — see [server/DOCUMENTATION.md](../../server/DOCUMENTATION.md).
+
+### Scope Categories
+
+The Python public surface spans three scope categories (see [SDK_MAP.md](../../SDK_MAP.md) for the full matrix):
+
+- **Consumer scope** — session/machine/task lifecycle, tool discovery, and remote invocation (`create_session`, `invoke`, `stream`, etc.). These methods are portable across maintained SDKs.
+- **Provider scope** — tool registration, request claiming, heartbeat, and result submission through the explicit `ProviderRuntime` surface. The client also exposes convenience aliases `tool()`, `start()`, and `stop()` over that same runtime surface.
+- **Admin scope** — session administration helpers (`list_user_sessions`, `bulk_delete_sessions`, `get_session_stats`, `invalidate_session`). These are currently exposed only in the Python SDK.
+
+## Installation
+
+The package is not published to PyPI yet; install it from the repository.
+
+```bash
+# Clone the repository
+git clone https://github.com/Abhishek-chohan/tool-control-plane.git
+cd tool-control-plane/clients/python-client
+
+# Install in development mode
+pip install -e .
+
+# Install with all development dependencies
+pip install -e ".[dev]"
+```
+
+Requirements: Python 3.8+ with grpcio, protobuf, requests, googleapis-common-protos, and pydantic. The optional toolkits under `toolplane/toolkits/` have heavier dependencies; install their requirements only if you use them. `grpcio-tools` is needed only for proto regeneration (`cd server && make gen-proto-python`).
+
+## Quick Start
+
+### Consumer Usage with gRPC Client
+
+```python
+from toolplane import Toolplane
+
+# Initialize a consumer-oriented client
+client = Toolplane(
+    server_host="localhost",
+    server_port=9001,
+    api_key="your-api-key-here",
+)
+
+client.connect()
+
+# Attach to an existing provider-backed session
+session_id = "provider-session-123"
+tools = client.get_available_tools(session_id)
+print(tools)
+
+# Execute a tool synchronously
+result = client.invoke("echo-tool", session_id, text="Hello World")
+print(result)  # Output: Echo: Hello World
+
+# Submit a tool invocation without blocking; awaits the request ID
+import asyncio
+request_id = asyncio.run(
+    client.ainvoke("echo-tool", session_id, text="Async Test")
+)
+print(f"Request ID: {request_id}")
+# Poll client.get_request_status(session_id, request_id) for the outcome.
+
+# Stream tool execution
+def stream_callback(chunk, is_final):
+    if is_final:
+        print("Stream completed")
+    else:
+        print(f"Received chunk: {chunk}")
+
+client.stream("echo-tool", stream_callback, session_id, text="Streaming Test")
+```
+
+### Explicit Provider Runtime with gRPC Client
+
+```python
+from toolplane import Toolplane
+
+client = Toolplane(
+    server_host="localhost",
+    server_port=9001,
+    api_key="your-api-key-here",
+    user_id="provider-user",
+)
+
+provider = client.provider_runtime()
+session = provider.create_session(
+    name="My Provider Session",
+    description="Session backed by the explicit provider runtime",
+    namespace="development",
+)
+
+@provider.tool(
+    session_id=session.session_id,
+    name="echo-tool",
+    description="Echo back the input text",
+    tags=["utility", "testing"],
+)
+def echo_tool(text: str) -> str:
+    return f"Echo: {text}"
+
+provider.run_forever()
+```
+
+### Explicit Provider Runtime with HTTP Client
+
+```python
+from toolplane import ToolplaneHTTP
+
+# Initialize HTTP client against the gateway (default port 8080)
+client = ToolplaneHTTP(
+    server_host="localhost",
+    server_port=8080,
+    api_key="your-api-key-here",
+)
+
+# Create an explicit provider runtime
+provider = client.provider_runtime()
+session = provider.create_session(
+    user_id="user123",
+    name="My HTTP Provider Session",
+)
+
+# Register a tool
+@provider.tool(
+    session_id=session.session_id,
+    name="http-tool",
+    description="HTTP-based tool execution",
+)
+def http_tool(text: str) -> str:
+    return f"HTTP Processed: {text}"
+
+provider.run_forever()
+```
+
+Tools are session-scoped: a consumer can only invoke tools registered into the same session, so separate provider and consumer processes must share a session ID (this is what the examples arrange through `TOOLPLANE_SESSION_ID`).
+
+## Session Management
+
+```python
+# Consumer-side session creation does not imply machine registration
+session = client.create_session(
+    session_id="my-unique-session-id",
+    user_id="user123",
+    name="My Application Session",
+    description="Session for my application",
+    namespace="production",
+    register_machine=False,
+)
+
+# Provider-side session creation uses the explicit runtime and attaches a machine
+provider = client.provider_runtime()
+provider_session = provider.create_session(
+    user_id="user123",
+    name="Provider Session",
+    namespace="production",
+)
+
+# Get an existing session
+session_context = client.get_session("my-unique-session-id")
+
+# List user sessions with pagination (page_token is the opaque cursor
+# returned by the previous page; it is a string, not an offset)
+user_sessions = client.list_user_sessions(
+    user_id="user123",
+    page_size=10,
+    page_token="",
+)
+
+# Get session statistics
+stats = client.get_session_stats(user_id="user123")
+print(f"Total sessions: {stats['total_sessions']}")
+
+# Bulk delete sessions
+bulk_delete_result = client.bulk_delete_sessions(
+    user_id="user123",
+    session_ids=["session-1", "session-2"],
+)
+
+# Invalidate a session (revokes every live API key of the session)
+success = client.invalidate_session("session-123", reason="Session expired")
+print(f"Session invalidated: {success}")
+```
+
+## Tool Management
+
+```python
+# Registration uses the explicit provider runtime
+provider = client.provider_runtime(["session-123"])
+provider.attach_session("session-123", register_machine=True)
+
+# Register a tool with automatic schema generation
+@provider.tool(
+    session_id="session-123",
+    name="process-data",
+    description="Process and transform data",
+    tags=["data-processing", "utility"],
+)
+def process_data(input: str, format: str = "json") -> dict:
+    return {"input": input, "format": format, "processed": True}
+
+# Register a streaming tool
+@provider.tool(
+    session_id="session-123",
+    name="stream-data",
+    description="Stream data processing",
+    stream=True,
+)
+def stream_data(input: str):
+    for char in input:
+        yield f"Processing: {char}"
+
+# Discover tools in the session
+available_tools = client.get_available_tools("session-123")
+print(f"Available tools: {available_tools}")
+```
+
+## Machine Management
+
+```python
+# Consumer sessions are not machine-backed by default; attach through
+# the provider runtime to register a machine
+provider = client.provider_runtime(["session-123"])
+session_context = provider.attach_session("session-123", register_machine=True)
+machine_id = session_context.machine_id
+print(f"Registered machine ID: {machine_id}")
+
+# Public machine-management helpers stay on the client
+machine_status = client.get_machine("session-123", machine_id)
+print(f"Machine status: {machine_status}")
+
+# Drain the machine gracefully before shutdown, then unregister
+client.drain_machine("session-123", machine_id)
+client.unregister_machine("session-123", machine_id)
+```
+
+Heartbeats are owned by the explicit provider runtime (`heartbeat_interval` on the client constructor configures the cadence); you never send them yourself.
+
+## Request Processing
+
+```python
+# Create a request directly (the same path invoke() uses)
+request_id = client.create_request(
+    session_id="session-123",
+    tool_name="process-data",
+    input_data='{"input": "test", "format": "json"}',
+)
+
+# Poll request status: arguments are (session_id, request_id)
+status = client.get_request_status("session-123", request_id)
+print(f"Request status: {status['status']}")
+
+# List requests in a session; page_token is the cursor from the previous page
+requests = client.list_requests("session-123", status="done", limit=10, page_token="")
+
+# Cancel a request
+client.cancel_request("session-123", request_id)
+```
+
+## Configuration Parameters
+
+#### `Toolplane` (gRPC facade)
+
+| Parameter | Type | Default | Description |
+| --- | --- | --- | --- |
+| `server_host` | str | "localhost" | Server hostname |
+| `server_port` | int | 9001 | Server port |
+| `use_tls` | bool | False | Enable TLS encryption |
+| `tls_cert_path` | str | None | Optional client TLS certificate for mutual TLS |
+| `tls_key_path` | str | None | Optional client TLS private key for mutual TLS |
+| `tls_ca_cert_path` | str | None | Optional CA bundle for direct gRPC TLS |
+| `tls_server_name` | str | None | Optional TLS server name override |
+| `api_key` | str | None | Authentication API key |
+| `user_id` | str | None | User identifier |
+| `session_name` | str | None | Session name |
+| `session_description` | str | None | Session description |
+| `session_namespace` | str | None | Session namespace |
+| `heartbeat_interval` | int | 60 | Heartbeat interval in seconds |
+| `max_workers` | int | 10 | Maximum worker threads |
+| `request_timeout` | int | 30 | Request timeout in seconds |
+| `max_retries` | int | 3 | Maximum retry attempts |
+| `retry_base_delay` | float | 1.0 | Base retry delay in seconds |
+| `retry_max_delay` | float | 60.0 | Maximum retry delay in seconds |
+| `retry_backoff_factor` | float | 2.0 | Exponential backoff factor |
+| `debug` | bool | False | Enable debug logging |
+| `log_level` | str | "INFO" | Logging level |
+
+#### `ToolplaneHTTP` (HTTP gateway facade)
+
+| Parameter | Type | Default | Description |
+| --- | --- | --- | --- |
+| `server_host` | str | "localhost" | Gateway hostname |
+| `server_port` | int | 8080 | Gateway port |
+| `api_key` | str | None | Authentication API key |
+| `user_id` | str | None | User identifier |
+| `session_name` | str | None | Session name |
+| `session_description` | str | None | Session description |
+| `session_namespace` | str | None | Session namespace |
+| `max_buffer_size` | int | 4194304 | Buffer size (4MB) |
+| `max_retries` | int | 3 | Maximum retry attempts |
+| `request_timeout` | int | 30 | Request timeout in seconds |
+| `retry_backoff_ms` | int | 250 | Retry backoff in milliseconds |
+| `heartbeat_interval` | int | 60 | Heartbeat interval in seconds |
+| `max_workers` | int | 10 | Maximum worker threads |
+
+Configuration commonly comes from the environment; the examples read `TOOLPLANE_SERVER_HOST`, `TOOLPLANE_SERVER_PORT`, `TOOLPLANE_API_KEY`, `TOOLPLANE_USER_ID`, `TOOLPLANE_USE_TLS`, `TOOLPLANE_TLS_CA_CERT_PATH`, and `TOOLPLANE_TLS_SERVER_NAME`, defaulting the port to 9001 and the API key to `toolplane-conformance-fixture-key`.
+
+## Error Handling
+
+The client raises a typed hierarchy rooted at `ToolplaneError`:
+
+```python
+from toolplane import ToolplaneError, ToolplaneNotFoundError
+
+try:
+    client.invoke("missing-tool", session_id)
+except ToolplaneNotFoundError as e:
+    print(f"Tool not found: {e}")
+except ToolplaneError as e:
+    print(f"Toolplane error: {e}")
+```
+
+| Exception | Raised for |
+| --- | --- |
+| `ToolplaneError` | Base class for every client error |
+| `ConnectionError` | The server is unreachable or the channel dropped |
+| `ToolError` / `SessionError` / `MachineError` / `RequestError` / `TaskError` | Domain-level failures in the matching resource |
+| `ToolplaneAPIError` | Base for gRPC status-mapped server errors |
+| `ToolplaneNotFoundError`, `ToolplaneInvalidArgumentError`, `ToolplaneFailedPreconditionError`, `ToolplaneResourceExhaustedError`, `ToolplaneUnauthenticatedError`, `ToolplanePermissionDeniedError`, `ToolplaneAlreadyExistsError`, `ToolplaneTimeoutError`, `ToolplaneUnavailableError`, `ToolplaneCancelledError`, `ToolplaneInternalError` | The matching gRPC status returned by the server |
+
+## API Reference
+
+<!-- BEGIN GENERATED: api-surface -- tooling: tools/gen_sdk_readmes.py; edits inside this block are overwritten -->
+#### `Toolplane`
+
+Public methods parsed from `toolplane/toolplane_client.py`:
+
+| Method | Description |
+| --- | --- |
+| `connect() -> bool` | Connect to Toolplane server. |
+| `disconnect() -> None` | Disconnect from Toolplane server. |
+| `ensure_session_context(session_id: str, create_if_missing: bool=False, register_machine: bool=False) -> SessionContext` | Ensure a local session context exists without implying provider startup. |
+| `create_session(session_id: Optional[str]=None, user_id: Optional[str]=None, name: Optional[str]=None, description: Optional[str]=None, namespace: Optional[str]=None, register_machine: bool=False) -> SessionContext` | Create a new session. |
+| `get_session(session_id: str) -> Optional[SessionContext]` | Get session context by ID. |
+| `list_sessions() -> List[SessionContext]` | List all session contexts. |
+| `list_user_sessions(user_id: str, page_size: int=10, page_token: str='', filter: str='') -> Dict[str, Any]` | List user sessions with pagination and filtering. |
+| `bulk_delete_sessions(user_id: str, session_ids: Optional[List[str]]=None, filter: str='') -> Dict[str, Any]` | Bulk delete sessions for a user. |
+| `get_session_stats(user_id: str) -> Dict[str, int]` | Get session statistics for a user. |
+| `invalidate_session(session_id: str, reason: str='') -> bool` | Invalidate a session. |
+| `update_session(session_id: str, name: Optional[str]=None, description: Optional[str]=None, namespace: Optional[str]=None) -> Dict[str, Any]` | Update session metadata. |
+| `create_request(session_id: str, tool_name: str, input_data: str, idempotency_key: str='') -> str` | Create a new request in a session. |
+| `list_requests(session_id: str, status: str='', tool_name: str='', limit: int=10, page_token: str='') -> List[Dict[str, Any]]` | List requests in a session. |
+| `list_requests_page(session_id: str, status: str='', tool_name: str='', limit: int=10, page_token: str='') -> Dict[str, Any]` | List one page of requests, with the continuation cursor. |
+| `cancel_request(session_id: str, request_id: str) -> bool` | Cancel a request in a session. |
+| `create_task(session_id: str, tool_name: str, input_data: str) -> Dict[str, Any]` | Create a new task in a session. |
+| `get_task(session_id: str, task_id: str) -> Dict[str, Any]` | Get a task by ID in a session. |
+| `list_tasks(session_id: str) -> List[Dict[str, Any]]` | List tasks in a session. |
+| `cancel_task(session_id: str, task_id: str) -> bool` | Cancel a task in a session. |
+| `list_machines(session_id: str) -> List[Dict[str, Any]]` | List machines in a session. |
+| `get_machine(session_id: str, machine_id: str) -> Dict[str, Any]` | Get a machine by ID. |
+| `unregister_machine(session_id: str, machine_id: Optional[str]=None) -> bool` | Unregister a machine from a session. |
+| `drain_machine(session_id: str, machine_id: Optional[str]=None) -> bool` | Drain a machine from a session. |
+| `create_api_key(session_id: str, name: str, capabilities: List[str]) -> Dict[str, Any]` | Create a new API key for a session. |
+| `list_api_keys(session_id: str) -> List[Dict[str, Any]]` | List active API keys for a session. |
+| `revoke_api_key(session_id: str, key_id: str) -> bool` | Revoke an API key for a session. |
+| `tool(session_id: str, name: Optional[str]=None, description: Optional[str]=None, stream: bool=False, tags: Optional[List[str]]=None) -> Callable[[Callable], Callable]` | Decorator to register a tool for a session. |
+| `invoke(tool_name: str, session_id: str, timeout_seconds: int=0, wait_timeout: Optional[int]=None, **params) -> Any` | Invoke a tool in a session and return the tool result value. |
+| `async ainvoke(tool_name: str, session_id: str, timeout_seconds: int=0, **params) -> str` | Submit a tool invocation without blocking; awaits the request ID. |
+| `stream(tool_name: str, callback: Callable[[Any, bool], None], session_id: str, timeout_seconds: int=0, **params) -> List[Any]` | Stream tool execution. |
+| `async astream(tool_name: str, callback: Callable[[Any, bool], None], session_id: str, timeout_seconds: int=0, **params) -> List[Any]` | Awaitable stream: resolves with the collected chunks. |
+| `get_available_tools(session_id: str) -> Dict[str, Any]` | Get available tools for a session. |
+| `list_tools(session_id: str) -> List[Dict[str, Any]]` | List tools for a session. |
+| `get_tool_by_id(session_id: str, tool_id: str) -> Dict[str, Any]` | Get a tool by ID. |
+| `get_tool_by_name(session_id: str, tool_name: str) -> Dict[str, Any]` | Get a tool by name. |
+| `delete_tool(session_id: str, tool_id: str) -> bool` | Delete a tool by ID. |
+| `get_request_status(session_id: str, request_id: str) -> Dict[str, Any]` | Get request status (session-scoped, like every other facade method). |
+| `provider_runtime(session_ids: Optional[List[str]]=None)` | Return the explicit provider runtime for this client. |
+| `start() -> None` | Backward-compatible alias for the explicit provider runtime. |
+| `stop() -> None` | Stop the explicit provider runtime if it is active. |
+
+#### `ToolplaneHTTP`
+
+Public methods parsed from `toolplane/toolplane_http_client.py`:
+
+| Method | Description |
+| --- | --- |
+| `connect() -> bool` | Connect to HTTP server. |
+| `disconnect()` | Disconnect from HTTP server. |
+| `ensure_session_context(session_id: str, create_if_missing: bool=False, register_machine: bool=False) -> HTTPSessionContext` | Ensure a local session context exists without implying provider startup. |
+| `create_session(session_id: Optional[str]=None, user_id: Optional[str]=None, name: Optional[str]=None, description: Optional[str]=None, namespace: Optional[str]=None, register_machine: bool=False) -> HTTPSessionContext` | Create a new session. |
+| `get_session(session_id: str) -> Optional[HTTPSessionContext]` | Get session context by ID. |
+| `list_sessions() -> List[HTTPSessionContext]` | List all session contexts. |
+| `get_primary_session_context() -> Optional[HTTPSessionContext]` | Get primary session context. |
+| `tool(session_id: str, name: Optional[str]=None, description: Optional[str]=None, stream: bool=False, tags: Optional[List[str]]=None)` | Decorator to register a tool for a session. |
+| `invoke(tool_name: str, session_id: str, timeout_seconds: int=0, wait_timeout: Optional[int]=None, **params) -> Any` | Invoke a tool in a session and return the tool result value. |
+| `async ainvoke(tool_name: str, session_id: str, timeout_seconds: int=0, **params) -> str` | Submit a tool invocation without blocking; awaits the request ID. |
+| `stream(tool_name: str, callback: Callable[[Any, bool], None], session_id: str, **params) -> List[Any]` | Stream tool execution. |
+| `async astream(tool_name: str, callback: Callable[[Any, bool], None], session_id: str, **params) -> List[Any]` | Awaitable stream: resolves with the collected chunks. |
+| `get_available_tools(session_id: str) -> Dict[str, Any]` | Get available tools for a session. |
+| `list_tools(session_id: str) -> List[Dict[str, Any]]` | List tools for a session. |
+| `get_tool_by_id(session_id: str, tool_id: str) -> Dict[str, Any]` | Get a tool by ID. |
+| `get_tool_by_name(session_id: str, tool_name: str) -> Dict[str, Any]` | Get a tool by name. |
+| `delete_tool(session_id: str, tool_id: str) -> bool` | Delete a tool by ID. |
+| `get_request_status(session_id: str, request_id: str) -> Dict[str, Any]` | Get request status (session-scoped, like every other facade method). |
+| `list_user_sessions(user_id: str, page_size: int=10, page_token: str='', filter: str='') -> Dict[str, Any]` | List user sessions with pagination and filtering. |
+| `bulk_delete_sessions(user_id: str, session_ids: List[str]=None, filter: str='') -> Dict[str, Any]` | Bulk delete sessions for a user. |
+| `get_session_stats(user_id: str) -> Dict[str, int]` | Get session statistics for a user. |
+| `invalidate_session(session_id: str, reason: str='') -> bool` | Invalidate a session. |
+| `update_session(session_id: str, name: Optional[str]=None, description: Optional[str]=None, namespace: Optional[str]=None) -> Dict[str, Any]` | Update session metadata. |
+| `create_request(session_id: str, tool_name: str, input_data: str, idempotency_key: str='') -> str` | Create a new request in a session. |
+| `list_requests(session_id: str, status: str='', tool_name: str='', limit: int=10, page_token: str='') -> List[Dict[str, Any]]` | List requests in a session. |
+| `list_requests_page(session_id: str, status: str='', tool_name: str='', limit: int=10, page_token: str='') -> Dict[str, Any]` | List one page of requests, with the continuation cursor. |
+| `cancel_request(session_id: str, request_id: str) -> bool` | Cancel a request in a session. |
+| `create_task(session_id: str, tool_name: str, input_data: str) -> Dict[str, Any]` | Create a new task in a session. |
+| `get_task(session_id: str, task_id: str) -> Dict[str, Any]` | Get a task by ID in a session. |
+| `list_tasks(session_id: str) -> List[Dict[str, Any]]` | List tasks in a session. |
+| `cancel_task(session_id: str, task_id: str) -> bool` | Cancel a task in a session. |
+| `list_machines(session_id: str) -> List[Dict[str, Any]]` | List machines in a session. |
+| `get_machine(session_id: str, machine_id: str) -> Dict[str, Any]` | Get a machine by ID. |
+| `unregister_machine(session_id: str, machine_id: Optional[str]=None) -> bool` | Unregister a machine from a session. |
+| `drain_machine(session_id: str, machine_id: Optional[str]=None) -> bool` | Drain a machine from a session. |
+| `create_api_key(session_id: str, name: str, capabilities: List[str]) -> Dict[str, Any]` | Create a new API key for a session. |
+| `list_api_keys(session_id: str) -> List[Dict[str, Any]]` | List active API keys for a session. |
+| `revoke_api_key(session_id: str, key_id: str) -> bool` | Revoke an API key for a session. |
+| `provider_runtime(session_ids: Optional[List[str]]=None)` | Return the explicit provider runtime for this client. |
+| `start()` | Backward-compatible alias for the explicit provider runtime. |
+| `stop()` | Stop the explicit provider runtime if it is active. |
+| `health()` | Check server health. |
+
+#### `ProviderRuntime`
+
+Public methods parsed from `toolplane/provider_runtime.py`:
+
+| Method | Description |
+| --- | --- |
+| `running -> bool` | Property. |
+| `add_sessions(session_ids: Optional[Iterable[str]]) -> None` |  |
+| `managed_session_ids() -> List[str]` |  |
+| `attach_session(session_id: str, register_machine: bool=True)` |  |
+| `create_session(session_id: Optional[str]=None, user_id: Optional[str]=None, name: Optional[str]=None, description: Optional[str]=None, namespace: Optional[str]=None, register_machine: bool=True)` |  |
+| `register_tool(session_id: str, name: str, func: Callable, schema: Optional[dict]=None, description: Optional[str]=None, stream: bool=False, tags: Optional[List[str]]=None) -> Callable` |  |
+| `tool(session_id: Optional[str]=None, name: Optional[str]=None, description: Optional[str]=None, stream: bool=False, tags: Optional[List[str]]=None)` | Queue a tool for registration at runtime start. |
+| `poll_once() -> None` |  |
+| `start_in_background(session_ids: Optional[Iterable[str]]=None) -> 'ProviderRuntime'` |  |
+| `run_forever(session_ids: Optional[Iterable[str]]=None) -> None` |  |
+| `stop() -> None` |  |
+| `close() -> None` |  |
+<!-- END GENERATED: api-surface -->
+
+## Contributing
+
+Contributions are welcome — see the [repository-level README](../../README.md) Contributing section for the required checks. Run the Python suites locally with:
+
+```bash
+cd server
+make python-unit            # unit tests
+make conformance-python     # shared-fixture conformance
+```
+
+## Support
+
+- Advanced API reference: [MANUAL.md](MANUAL.md)
+- Example walkthrough: [README_EXAMPLES.md](README_EXAMPLES.md)
+- Package architecture: [ARCHITECTURE.md](ARCHITECTURE.md)
+- Issues: [open one on the GitHub repository](https://github.com/Abhishek-chohan/tool-control-plane/issues)

toolplane_python_client-0.1.0.dist-info/RECORD

@@ -0,0 +1,81 @@
+toolplane/__init__.py,sha256=VOb4oztCIfY5GP-yccU4lpbgqeFSWhvBgg2gZSJ6pjs,2666
+toolplane/provider_cli.py,sha256=87hYn9snp6z7XTXuWxAQKGECC-tXihsrQUq-jnlgvvU,9176
+toolplane/provider_registry.py,sha256=_7ZKKBOGn-vvr24gfwF03t6d4268qt8J2AvEAL3iSeU,2094
+toolplane/provider_runtime.py,sha256=IfB5ofss_MvcNBZZqxv_J1Ui2WvXoB7Q4Dzc5f3yWqw,10455
+toolplane/toolplane_client.py,sha256=nWAl-7ezD36oEDHGVeeQ5u5ZU3P5FddY6PjPGeGIF0s,25369
+toolplane/toolplane_http_client.py,sha256=ZWA3SkzH-VciTvW6MXq6b7-maZR1iGobZCv_E_y21yY,25148
+toolplane/common/__init__.py,sha256=lYa6uC-D7ldacgJjSiImwqlDuU1GwAMnw-BdWNoy-lM,2352
+toolplane/common/base_config.py,sha256=SapLuCMxdZLg2vvpUqs_KC8keQIrLNDagSZMCA6sp3w,4537
+toolplane/common/base_connection_manager.py,sha256=qz-sS8b4rkTSKpjBR63Bbj5jd27ODJ4ODmXX5PzF5TU,5214
+toolplane/common/base_session_manager.py,sha256=37a65TWzLV0hLnmC0IhZbf0P0NgFpVvwBg4HgHWpnG0,10608
+toolplane/common/base_tool_manager.py,sha256=o6J69U5xthfBH4MyeXbywv6rGSMUSoyloTt0W9kfeGM,11951
+toolplane/common/constants.py,sha256=VMVseqhhQTEEMBcMGhJ1m6ZSPs6U8f5bKi_tQ46yw4g,1582
+toolplane/common/utils.py,sha256=eRpGoMBLrlk4eBqDFmVIupeGUBcbHfGYIz7MOpgEEhI,9111
+toolplane/core/__init__.py,sha256=Q8N7n9sf9-8WTA2BStExeJuB6K-y2lt2C_AUEHULXT4,1781
+toolplane/core/config.py,sha256=jRoMVc_hoeqfwaav8UwVYdWoVvPiBYBG82w3AluJkkk,3858
+toolplane/core/connection.py,sha256=pD0zicdVQGY6rNNNsmGAE66rIfoCpNkTCifkFgw4MDI,10790
+toolplane/core/errors.py,sha256=ddeZ32RdGSwlgQKw8JyFtKnrmbxEcMYhq05cRorVEY8,9562
+toolplane/core/machine.py,sha256=ksG8JdK0QmBOPd0zwjdq4BPOfE4w5-lS6S57E4wazyU,17484
+toolplane/core/request.py,sha256=XjtjHjaJ42lBShXCXqwRWX-pr9gIzyfmSy5sLrV34fA,26630
+toolplane/core/session.py,sha256=WiuwZl6r80NwRRxjMJIOC8ylyiT7w8RIL4TUx60eOo0,11802
+toolplane/core/session_context.py,sha256=VLwyle33cA6oeE-Pam-zapPUj5rU7Im-ok2vEiV5kL0,18506
+toolplane/core/task.py,sha256=COuxyoERoAioQbkjXj7pwqNtmzYBSWR099kADjWtE8M,4951
+toolplane/core/tool.py,sha256=DFeKMdNC5_Y5bF5Q2gkditCqRywBIHiUUxFjb1Q9CVc,12620
+toolplane/http_core/__init__.py,sha256=CESVsLFujKeufk8TT7JtKe-A9B0aO6LJEemCplymyf8,927
+toolplane/http_core/http_config.py,sha256=JUdeElZtYmmypjlWZF9JSyKDzIe1W3W-nt6G7YiBGdg,3314
+toolplane/http_core/http_connection.py,sha256=AxrJIOIXxG0IC5B6itTj80N9YxeSkutJV1r6jvQDpNs,14356
+toolplane/http_core/http_machine.py,sha256=uhJo5JnwpS5Yxl3tgiqFPpNGXZPyDplyuknWhMIXbWY,10823
+toolplane/http_core/http_request.py,sha256=4VBWmVztpEh-HjFHX96aHLbLNaSMQNkUN-nIt8HrNvA,25999
+toolplane/http_core/http_session.py,sha256=zdKgB5rRkgWDYnLcocnIKg-Wg-kXnIoetbfeUatk4DI,12681
+toolplane/http_core/http_session_context.py,sha256=ulounQrxX20uzE3BYGJaFdprdbJHtcGqTJcDPCIuXNY,18121
+toolplane/http_core/http_task.py,sha256=L-E7cjd4rA73Bzj98TpDuYdzREgEMqSSqe4RywW4iL0,4079
+toolplane/http_core/http_tool.py,sha256=Te_QprfpO22JqUnf7YI4FcPFwN7e1Jf9qnyuNw-7Als,14659
+toolplane/interfaces/__init__.py,sha256=rdV6dJ_REiZMbq2m2LlmDhlKPq1h7ym9IRDEeOvwuUI,846
+toolplane/interfaces/client_interface.py,sha256=umlv0tG8B9Wt02ObK3jIPMtJdPJOpcpdebWMvWSd6ME,3797
+toolplane/interfaces/connection_interface.py,sha256=FS5NSGoUuSL5H_Se5Na04Rchx3nVUOJO1TqpArfktR0,5526
+toolplane/interfaces/event_interface.py,sha256=z6H0v0lio0pPWPkkXDLr_NbZScDJMZuK2ojyl7g7G7M,9107
+toolplane/interfaces/request_interface.py,sha256=YP6V22jx5V6xSCHeZr26fgWyj8mGhox9cmRk78Hstxo,13340
+toolplane/interfaces/session_interface.py,sha256=XNvBp965x94N2d-kGTGhEMOg0G1tdfL3WToqjyG2yU8,9430
+toolplane/interfaces/tool_interface.py,sha256=aVN7nWZTIhlVEcbCy1MEJaodoPUbjIWysyjTDETzNbY,14220
+toolplane/proto/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+toolplane/proto/service_pb2.py,sha256=ZlFtsXIjetDYw9uizIOyc5w5Du9eAt4G5E_CAoT9ITA,44670
+toolplane/proto/service_pb2_grpc.py,sha256=Jd-PeE8VVKvtp3k9XP-hZBFYtlB8q5ieUZ2b0JDDJRY,88951
+toolplane/toolkits/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+toolplane/toolkits/standalone_tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+toolplane/toolkits/standalone_tools/create_directory.py,sha256=jxdXpE-GclcRLp_kfxVvaMVkT9EbB0WUHbUT1Cr4Ej4,2890
+toolplane/toolkits/standalone_tools/create_file.py,sha256=_9iXmXt1GyxgqqSoPzOLkWpTVXaBbyMgWMdc-YTBIDQ,3964
+toolplane/toolkits/standalone_tools/file_search.py,sha256=wlu4tUD2MW2crsWvfORZhTV2hiLuJ7dRlP5-GZaAxL4,7262
+toolplane/toolkits/standalone_tools/grep_search.py,sha256=4NF5FdVNdRfcN8XctXBYbtcTOlu2YGotCeXlxsliK5Q,10687
+toolplane/toolkits/standalone_tools/launcher.py,sha256=DjMFENQQhZzPgwCHZ58ecCV7akV6rbu_PON_Yg4Ani0,4365
+toolplane/toolkits/standalone_tools/list_dir.py,sha256=ampfoYEvJq9NNsy__sjzChpB70_5Mgyc9Q1DjM6nFSk,13006
+toolplane/toolkits/standalone_tools/read_file.py,sha256=oFCMCS6JGm65dG0o7NUDSsZH2g1ghUZwDOgWY8nqj1k,10506
+toolplane/toolkits/standalone_tools/replace_string_in_file.py,sha256=_2Rz-dlCRyMnH12KpVnWCLPhuqgZq66dZOD-iIpBt9g,13516
+toolplane/toolkits/standalone_tools/run_tests.py,sha256=wY6nZWIMXV2CZAEQ1Q7jnKuQVUSf-0EgGL349Bt5GBM,1813
+toolplane/toolkits/standalone_tools/semantic_search.py,sha256=AuLenPHDW00NGPL7ILqhDYqdcZLjLABYUYEy31GpcQs,14443
+toolplane/toolkits/standalone_tools/standalone_toolkit.py,sha256=AWVS4ap1OKxPs67aiLNhLEWw7KbENiKGUJQav12OCuA,35141
+toolplane/toolkits/standalone_tools/test_failure_analysis.py,sha256=O1Z7Z5266iOW5uIpUF0aXVF74vAt_hnRSp0zRTrCo4k,20898
+toolplane/toolkits/standalone_tools/test_standalone_toolkit.py,sha256=XQRgXnfYCYu_ahzX2y4KBSaIfDH1pittdSEsBeaVhgg,18112
+toolplane/toolkits/swe/__init__.py,sha256=Ql-hdU6jPWIdwwZQblfJu5qlkwiW6VDKrbo7OGg9Imw,664
+toolplane/toolkits/swe/create_directory.py,sha256=CCrJ2t7-NrWMQvB3d110PDRu4wIgN5oU96lNglrg98A,400
+toolplane/toolkits/swe/create_file.py,sha256=1DVsvJx4uPjXnGC1C8u2wDQ2ndrvfbUN1CNmGTSzPik,390
+toolplane/toolkits/swe/descriptions.py,sha256=D9pYfZ2WZjWpeg3jJm3yKCGq-2_cFnG1BKboD7jRm-U,11766
+toolplane/toolkits/swe/execute_bash.py,sha256=ettykydDNEjYd78vdABhxQAwxDI2-YyccimrauybPXU,2932
+toolplane/toolkits/swe/file_editor.py,sha256=l2HRFvgN5zFAXlVExPBmHcgaiJzi59ppVLCEVSgdrkI,29405
+toolplane/toolkits/swe/file_search.py,sha256=JKltNkySi_HbUvWw7Ct2jFcHxbfJH1GeKt64iwXYzoo,407
+toolplane/toolkits/swe/finish.py,sha256=lJkTclzO1YLUFiaFnjfY2nYp46Q38o6Ky2D3axZ3idE,1494
+toolplane/toolkits/swe/grep_search.py,sha256=eRc7vtVoV_Wmo9hiO034TKVbBqWYU7sxgTgzhyWb-3E,475
+toolplane/toolkits/swe/list_dir.py,sha256=-wOSxQ-2k4sRYIfCKkZaQqW9mDYeBGp9i5m8RqFf7cY,13451
+toolplane/toolkits/swe/read_file.py,sha256=NeI8z6ztsiCk0ccHIY8UIgJuFXR200pfMYmDJ05_HY4,449
+toolplane/toolkits/swe/replace_string_in_file.py,sha256=_wgmKiSlgogznhg4QAToi_AuHqk627f3TwRN7p7tB6w,472
+toolplane/toolkits/swe/search.py,sha256=b_Z9HWy1FPFn1YAg-B-3nUeiTbd2G8GJy-jSZUIG3yk,9370
+toolplane/toolkits/swe/semantic_search.py,sha256=Zcd5Ls3FwJKr8lWGZDBzMylBYMn5-oPQB4ENGL87Aa8,523
+toolplane/toolkits/swe/str_replace_editor.py,sha256=Q43mJonOUbFiothzGa10eSN-89FA7_AdhlCwxv5WLs4,23630
+toolplane/toolkits/swe/submit.py,sha256=pRRjofidgf24RcWD2vhwgjFLr7bBOAAV9NSvqYbwlL8,547
+toolplane/toolkits/swe/swe_toolkit.py,sha256=Eh9Jrccc-H2D1zEQkGM2IsH_aMGqv0fD6E8ho0ajem8,44835
+toolplane/utils/__init__.py,sha256=w_djmtPagjMs-KyUy9MN09J-x-4ShX2SBRah38pSy2U,139
+toolplane/utils/schema.py,sha256=X2WjsAakymlaV5-dgsUZiciKyzsrw6ErTPYA8ZcYuxI,4406
+toolplane_python_client-0.1.0.dist-info/METADATA,sha256=TRFWd5xwQnOMWko5xTUZPkK-ydsTof8tkuJm58FtIrM,28378
+toolplane_python_client-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+toolplane_python_client-0.1.0.dist-info/entry_points.txt,sha256=JkR2hs-auiqhLpTqwy4nfUj24WRUn5Fe_rs6us6W2J0,67
+toolplane_python_client-0.1.0.dist-info/top_level.txt,sha256=siTUe6zrWvaqnzl_wEXbc2gEQyGKNCxg3pkzuXP895g,10
+toolplane_python_client-0.1.0.dist-info/RECORD,,

toolplane_python_client-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

toolplane_python_client-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+toolplane-provider = toolplane.provider_cli:main

toolplane_python_client-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+toolplane