swarmauri_tool_jupyterdisplay 0.8.3.dev10

A tool designed to display rich media and object representations in a Jupyter Notebook using IPython's display functionality.

---

Swarmauri Tool Jupyter Display

Tool for displaying text, HTML, images, or LaTeX in a Jupyter notebook using IPython's rich display helpers.

Features

• Accepts data and optional data_format (auto, text, html, image, latex).
• Uses IPython.display to render the appropriate representation.
• Returns a status dictionary indicating success or failure.

Prerequisites

• Python 3.10 or newer.
• Running inside a Jupyter notebook or environment that supports IPython display.
• IPython installed (pulled in automatically).

Installation

# pip
pip install swarmauri_tool_jupyterdisplay

# poetry
poetry add swarmauri_tool_jupyterdisplay

# uv (pyproject-based projects)
uv add swarmauri_tool_jupyterdisplay

Quickstart

from swarmauri_tool_jupyterdisplay import JupyterDisplayTool

display_tool = JupyterDisplayTool()
print(display_tool("<b>Hello, world!</b>", data_format="html"))

Displaying Images

from swarmauri_tool_jupyterdisplay import JupyterDisplayTool

image_path = "plots/chart.png"
JupyterDisplayTool()(image_path, data_format="image")

Tips

• Use data_format="auto" (default) to treat the data as Markdown text.
• Provide absolute or notebook-relative paths for images when using data_format="image".
• Wrap calls in Swarmauri tool chains to render results (e.g., charts, HTML reports) inline during agent runs.

Want to help?

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