penguiflow 1.0.2__tar.gz → 1.0.3__tar.gz

{penguiflow-1.0.2 → penguiflow-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: penguiflow
-Version: 1.0.2
+Version: 1.0.3
 Summary: Async agent orchestration primitives.
 Author: PenguiFlow Team
 License: MIT License
@@ -99,7 +99,7 @@ from penguiflow.node import Node
 class QueryOut(BaseModel):
     topic: str
 
-async def triage(m: QueryIn) -> QueryOut:
+async def triage(msg: QueryIn, ctx) -> QueryOut:
     return QueryOut(topic="metrics")
 
 triage_node = Node(triage, name="triage")
@@ -328,6 +328,19 @@ flow focused on high-level orchestration logic.
 
 ---
 
+### Visualization
+
+Need a quick view of the flow topology? Call `flow_to_mermaid(flow)` to render the graph
+as a Mermaid diagram ready for Markdown or docs tools:
+
+```python
+from penguiflow import flow_to_mermaid
+
+print(flow_to_mermaid(flow, direction="LR"))
+```
+
+---
+
 ## 🛡️ Reliability & Observability
 
 * **NodePolicy**: set validation scope plus per-node timeout, retries, and backoff curves.
@@ -346,6 +359,14 @@ flow focused on high-level orchestration logic.
 
 ---
 
+## 📊 Benchmarks
+
+Lightweight benchmarks live under `benchmarks/`. Run them via `uv run python benchmarks/<name>.py`
+to capture baselines for fan-out throughput, retry/timeout overhead, and controller
+playbook latency. Copy them into product repos to watch for regressions over time.
+
+---
+
 ## 🔮 Roadmap
 
 * **v1 (current)**: safe core runtime, type-safety, retries, timeouts, routing, controller loops, playbooks via examples.

{penguiflow-1.0.2 → penguiflow-1.0.3}/README.md

@@ -60,7 +60,7 @@ from penguiflow.node import Node
 class QueryOut(BaseModel):
     topic: str
 
-async def triage(m: QueryIn) -> QueryOut:
+async def triage(msg: QueryIn, ctx) -> QueryOut:
     return QueryOut(topic="metrics")
 
 triage_node = Node(triage, name="triage")
@@ -289,6 +289,19 @@ flow focused on high-level orchestration logic.
 
 ---
 
+### Visualization
+
+Need a quick view of the flow topology? Call `flow_to_mermaid(flow)` to render the graph
+as a Mermaid diagram ready for Markdown or docs tools:
+
+```python
+from penguiflow import flow_to_mermaid
+
+print(flow_to_mermaid(flow, direction="LR"))
+```
+
+---
+
 ## 🛡️ Reliability & Observability
 
 * **NodePolicy**: set validation scope plus per-node timeout, retries, and backoff curves.
@@ -307,6 +320,14 @@ flow focused on high-level orchestration logic.
 
 ---
 
+## 📊 Benchmarks
+
+Lightweight benchmarks live under `benchmarks/`. Run them via `uv run python benchmarks/<name>.py`
+to capture baselines for fan-out throughput, retry/timeout overhead, and controller
+playbook latency. Copy them into product repos to watch for regressions over time.
+
+---
+
 ## 🔮 Roadmap
 
 * **v1 (current)**: safe core runtime, type-safety, retries, timeouts, routing, controller loops, playbooks via examples.

{penguiflow-1.0.2 → penguiflow-1.0.3}/penguiflow/__init__.py

@@ -15,6 +15,7 @@ from .node import Node, NodePolicy
 from .patterns import join_k, map_concurrent, predicate_router, union_router
 from .registry import ModelRegistry
 from .types import WM, FinalAnswer, Headers, Message, PlanStep, Thought
+from .viz import flow_to_mermaid
 
 __all__ = [
     "__version__",
@@ -37,7 +38,8 @@ __all__ = [
     "join_k",
     "predicate_router",
     "union_router",
+    "flow_to_mermaid",
     "create",
 ]
 
-__version__ = "1.0.2"
+__version__ = "1.0.3"

penguiflow-1.0.3/penguiflow/viz.py

@@ -0,0 +1,76 @@
+"""Visualization helpers for PenguiFlow graphs."""
+
+from __future__ import annotations
+
+import re
+from typing import TYPE_CHECKING
+
+from .core import Endpoint
+from .node import Node
+
+if TYPE_CHECKING:  # pragma: no cover - type checking only
+    from .core import PenguiFlow
+
+__all__ = ["flow_to_mermaid"]
+
+
+def flow_to_mermaid(flow: PenguiFlow, *, direction: str = "TD") -> str:
+    """Render the flow graph as a Mermaid diagram string.
+
+    Parameters
+    ----------
+    flow:
+        The `PenguiFlow` instance to visualize.
+    direction:
+        Mermaid graph direction ("TD", "LR", etc.). Defaults to top-down.
+    """
+
+    lines: list[str] = [f"graph {direction}"]
+    nodes: set[object] = set()
+
+    for floe in flow._floes:  # noqa: SLF001 - visualization accesses internals by design
+        if floe.source is not None:
+            nodes.add(floe.source)
+        if floe.target is not None:
+            nodes.add(floe.target)
+
+    id_lookup: dict[object, str] = {}
+    used_ids: set[str] = set()
+
+    for entity in nodes:
+        label = _display_label(entity)
+        node_id = _unique_id(label, used_ids)
+        used_ids.add(node_id)
+        id_lookup[entity] = node_id
+        lines.append(f"    {node_id}[\"{label}\"]")
+
+    for floe in flow._floes:  # noqa: SLF001
+        source = floe.source
+        target = floe.target
+        if source is None or target is None:
+            continue
+        src_id = id_lookup.get(source)
+        tgt_id = id_lookup.get(target)
+        if src_id is None or tgt_id is None:
+            continue
+        lines.append(f"    {src_id} --> {tgt_id}")
+
+    return "\n".join(lines)
+
+
+def _display_label(entity: object) -> str:
+    if isinstance(entity, Node):
+        return entity.name or entity.node_id
+    if isinstance(entity, Endpoint):
+        return entity.name
+    return str(entity)
+
+
+def _unique_id(label: str, used: set[str]) -> str:
+    base = re.sub(r"[^0-9A-Za-z_]", "_", label) or "node"
+    candidate = base
+    index = 1
+    while candidate in used:
+        index += 1
+        candidate = f"{base}_{index}"
+    return candidate

{penguiflow-1.0.2 → penguiflow-1.0.3}/penguiflow.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: penguiflow
-Version: 1.0.2
+Version: 1.0.3
 Summary: Async agent orchestration primitives.
 Author: PenguiFlow Team
 License: MIT License
@@ -99,7 +99,7 @@ from penguiflow.node import Node
 class QueryOut(BaseModel):
     topic: str
 
-async def triage(m: QueryIn) -> QueryOut:
+async def triage(msg: QueryIn, ctx) -> QueryOut:
     return QueryOut(topic="metrics")
 
 triage_node = Node(triage, name="triage")
@@ -328,6 +328,19 @@ flow focused on high-level orchestration logic.
 
 ---
 
+### Visualization
+
+Need a quick view of the flow topology? Call `flow_to_mermaid(flow)` to render the graph
+as a Mermaid diagram ready for Markdown or docs tools:
+
+```python
+from penguiflow import flow_to_mermaid
+
+print(flow_to_mermaid(flow, direction="LR"))
+```
+
+---
+
 ## 🛡️ Reliability & Observability
 
 * **NodePolicy**: set validation scope plus per-node timeout, retries, and backoff curves.
@@ -346,6 +359,14 @@ flow focused on high-level orchestration logic.
 
 ---
 
+## 📊 Benchmarks
+
+Lightweight benchmarks live under `benchmarks/`. Run them via `uv run python benchmarks/<name>.py`
+to capture baselines for fan-out throughput, retry/timeout overhead, and controller
+playbook latency. Copy them into product repos to watch for regressions over time.
+
+---
+
 ## 🔮 Roadmap
 
 * **v1 (current)**: safe core runtime, type-safety, retries, timeouts, routing, controller loops, playbooks via examples.

{penguiflow-1.0.2 → penguiflow-1.0.3}/penguiflow.egg-info/SOURCES.txt

@@ -18,4 +18,5 @@ tests/test_controller.py
 tests/test_core.py
 tests/test_patterns.py
 tests/test_registry.py
-tests/test_types.py
+tests/test_types.py
+tests/test_viz.py

{penguiflow-1.0.2 → penguiflow-1.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "penguiflow"
-version = "1.0.2"
+version = "1.0.3"
 description = "Async agent orchestration primitives."
 readme = "README.md"
 requires-python = ">=3.12"

penguiflow-1.0.3/tests/test_viz.py

@@ -0,0 +1,29 @@
+"""Tests for visualization helpers."""
+
+from __future__ import annotations
+
+import pytest
+
+from penguiflow import Node, NodePolicy, create
+from penguiflow.viz import flow_to_mermaid
+
+
+@pytest.mark.asyncio
+async def test_flow_to_mermaid_renders_edges() -> None:
+    async def fan(msg: str, ctx) -> str:
+        return msg
+
+    async def sink(msg: str, ctx) -> str:
+        return msg
+
+    fan_node = Node(fan, name="fan", policy=NodePolicy(validate="none"))
+    sink_node = Node(sink, name="sink", policy=NodePolicy(validate="none"))
+
+    flow = create(fan_node.to(sink_node))
+
+    mermaid = flow_to_mermaid(flow)
+
+    assert mermaid.startswith("graph TD")
+    assert "fan" in mermaid
+    assert "sink" in mermaid
+    assert "-->" in mermaid

penguiflow-1.0.2/penguiflow/viz.py

@@ -1,5 +0,0 @@
-"""Visualization helpers for PenguiFlow graphs."""
-
-from __future__ import annotations
-
-__all__: list[str] = []