10xscale-agentflow-cli 0.3.2__tar.gz → 0.3.2.1__tar.gz

{10xscale_agentflow_cli-0.3.2 → 10xscale_agentflow_cli-0.3.2.1}/10xscale_agentflow_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: 10xscale-agentflow-cli
-Version: 0.3.2
+Version: 0.3.2.1
 Summary: CLI and API for 10xscale AgentFlow
 Author-email: 10xscale <contact@10xscale.ai>
 Maintainer-email: Shudipto Trafder <shudiptotrafder@gmail.com>

{10xscale_agentflow_cli-0.3.2 → 10xscale_agentflow_cli-0.3.2.1}/10xscale_agentflow_cli.egg-info/SOURCES.txt

@@ -56,6 +56,7 @@ agentflow_cli/cli/templates/skills/agent-skills/references/rest-api-and-errors.m
 agentflow_cli/cli/templates/skills/agent-skills/references/security-and-validators.md
 agentflow_cli/cli/templates/skills/agent-skills/references/state-and-messages.md
 agentflow_cli/cli/templates/skills/agent-skills/references/state-graph.md
+agentflow_cli/cli/templates/skills/agent-skills/references/stream-emitter.md
 agentflow_cli/cli/templates/skills/agent-skills/references/streaming.md
 agentflow_cli/cli/templates/skills/agent-skills/references/testing-and-evaluation.md
 agentflow_cli/cli/templates/skills/copilot/agentflow.instructions.md

{10xscale_agentflow_cli-0.3.2 → 10xscale_agentflow_cli-0.3.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: 10xscale-agentflow-cli
-Version: 0.3.2
+Version: 0.3.2.1
 Summary: CLI and API for 10xscale AgentFlow
 Author-email: 10xscale <contact@10xscale.ai>
 Maintainer-email: Shudipto Trafder <shudiptotrafder@gmail.com>

{10xscale_agentflow_cli-0.3.2 → 10xscale_agentflow_cli-0.3.2.1}/agentflow_cli/cli/templates/skills/agent-skills/SKILL.md

@@ -12,6 +12,7 @@ metadata:
     - references/media-and-files.md
     - references/memory-and-store.md
     - references/streaming.md
+    - references/stream-emitter.md
     - references/production-runtime.md
     - references/api-client.md
     - references/remote-tools.md
@@ -65,6 +66,7 @@ Treat `agentflow-docs/docs` as the first source of truth for public package name
    - Multimodal files and media stores: `references/media-and-files.md`
    - Long-term memory stores: `references/memory-and-store.md`
    - Streaming, chunks, and SSE: `references/streaming.md`
+   - Stream emitter for tool progress updates: `references/stream-emitter.md`
    - API server and deployment runtime: `references/production-runtime.md`
    - REST and TypeScript client surface: `references/api-client.md`
    - Browser/client-side tool execution: `references/remote-tools.md`

10xscale_agentflow_cli-0.3.2.1/agentflow_cli/cli/templates/skills/agent-skills/references/stream-emitter.md

@@ -0,0 +1,144 @@
+# StreamEmitter
+
+Emit live progress, errors, and status updates from tools during streaming execution.
+
+## Overview
+
+`StreamEmitter` allows tools to send **live progress updates** back to the caller during `app.stream(...)` / `app.astream(...)` execution. Tools can report intermediate steps, retries, and errors in real-time without using an external publisher.
+
+## Key Points
+
+- **Streaming only**: Automatically injected during `app.stream()` / `app.astream()`, not during `invoke()` / `ainvoke()`
+- **Optional parameter**: Declare as `emit: StreamEmitter | None = None` in tool functions
+- **Thread-safe**: Works with both sync and async tools
+- **Built-in**: Uses the same streaming pipeline; no external publisher required
+
+## Common Methods
+
+### `progress(message: str, data: dict | None = None)`
+
+Emit a progress update showing intermediate steps or status changes.
+
+```python
+if emit:
+    emit.progress("Fetching data...", data={"attempt": 1, "max_attempts": 3})
+```
+
+### `error(message: str, data: dict | None = None)`
+
+Emit an error update (informational; doesn't interrupt execution).
+
+```python
+if emit:
+    emit.error("API timeout, using cache", data={"retry_count": 3})
+```
+
+### `message(message: str, data: dict | None = None)`
+
+Emit a plain informational message.
+
+```python
+if emit:
+    emit.message("Processing complete", data={"items_processed": 1000})
+```
+
+### `update(data: dict)`
+
+Emit a generic data update without a message.
+
+```python
+if emit:
+    emit.update({
+        "status": "batch_progress",
+        "processed": 50,
+        "total": 100,
+        "percentage": 50.0,
+    })
+```
+
+## Usage Pattern
+
+```python
+from agentflow.core.state.stream_emitter import StreamEmitter
+
+def my_tool(
+    param: str,
+    emit: StreamEmitter | None = None,
+) -> str:
+    """Tool that reports progress during streaming."""
+    if emit:
+        emit.progress("Starting work...")
+
+    # ... do work ...
+
+    if emit:
+        emit.progress("Finalizing...", data={"step": 2})
+
+    return "result"
+```
+
+## When to Use
+
+✅ **Use for:**
+- Long-running operations (API calls, file processing)
+- Retries with multiple attempts
+- Multi-step processes
+- Batch processing with progress tracking
+
+❌ **Don't use for:**
+- Fast operations (<100ms)
+- Non-streaming paths (emit will be None anyway)
+- Critical control flow (always return a result regardless)
+
+## Behavior
+
+| Execution Mode | Emit Parameter | Output |
+|---|---|---|
+| `app.stream()` | `StreamEmitter` | Progress updates in stream |
+| `app.astream()` | `StreamEmitter` | Progress updates in stream |
+| `app.invoke()` | `None` | No progress updates |
+| `app.ainvoke()` | `None` | No progress updates |
+
+## Stream Output
+
+Emitted chunks appear in the stream output with structure:
+
+```python
+{
+    "event": "message" | "error" | "update",
+    "data": {
+        "status": "tool_progress" | "tool_failed" | "tool_message" | ...,
+        "tool_name": "my_tool",
+        "tool_call_id": "call_abc123",
+        "node": "TOOL",
+        "message": "...",
+        "thread_id": "...",
+        "run_id": "...",
+        # ... plus any extra data passed
+    },
+}
+```
+
+## Performance Tips
+
+- Emit at meaningful intervals, not every iteration
+- For batch work: emit every N items, not on every item
+- Avoid thousands of updates per second
+
+```python
+# ❌ Too frequent
+for item in items:
+    if emit:
+        emit.progress(f"Processing {item}")
+
+# ✅ Batched
+for i, item in enumerate(items):
+    if (i + 1) % 100 == 0 and emit:
+        emit.progress(f"Processed {i + 1} of {len(items)}")
+```
+
+## See Also
+
+- [Tools](agents-and-tools.md) — Defining and registering tools
+- [Streaming](streaming.md) — Overview of streaming chunks
+- [Dependency Injection](dependency-injection.md) — How parameters like `emit` are injected

{10xscale_agentflow_cli-0.3.2 → 10xscale_agentflow_cli-0.3.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "10xscale-agentflow-cli"
-version = "0.3.2"
+version = "0.3.2.1"
 description = "CLI and API for 10xscale AgentFlow"
 readme = "README.md"
 license = {text = "MIT"}