swarmauri_tool_jupytergetiopubmessage 0.9.0.dev3

A tool designed to retrieve messages from the IOPub channel of a Jupyter kernel using jupyter_client, capturing cell outputs and logs.

---

Swarmauri Tool Jupyter Get IOPub Message

Listens to a Jupyter kernel’s IOPub channel and collects stdout/stderr/log messages for downstream processing.

Features

• Connects to /api/kernels/{id}/channels via websocket.
• Returns a dict containing captured stdout, stderr, logs, execution_results, and a timeout_exceeded flag.
• Built on jupyter_client with Swarmauri tool registration.

Prerequisites

• Python 3.10 or newer.
• jupyter_client, websocket-client installed (pulled automatically).
• Access to a running Jupyter kernel (e.g., Notebook server).

Installation

# pip
pip install swarmauri_tool_jupytergetiopubmessage

# poetry
poetry add swarmauri_tool_jupytergetiopubmessage

# uv (pyproject-based projects)
uv add swarmauri_tool_jupytergetiopubmessage

Quickstart

from swarmauri_tool_jupytergetiopubmessage import JupyterGetIOPubMessageTool

channels_url = "ws://localhost:8888/api/kernels/<kernel-id>/channels"
result = JupyterGetIOPubMessageTool()(channels_url, timeout=3.0)

print("stdout:", result["stdout"])
print("stderr:", result["stderr"])
print("logs:", result["logs"])
print("timeout?", result["timeout_exceeded"])

Tips

• Use alongside execution tools to capture live output during automated notebook runs.
• Ensure your environment handles Jupyter tokens/cookies if the server requires authentication.
• Increase timeout for longer-running cells to collect all outputs before returning.

Want to help?

If you want to contribute to swarmauri-sdk, read up on our guidelines for contributing that will help you get started.