Skip to main content

A tool designed to render HTML content within a Jupyter Notebook using IPython's HTML display method.

Project description

Swarmauri Logo

PyPI - Downloads Hits PyPI - Python Version PyPI - License PyPI - swarmauri_tool_jupyterdisplayhtml


Swarmauri Tool Jupyter Display HTML

Specialized wrapper for displaying HTML snippets in Jupyter notebooks via IPython's HTML display helper.

Features

  • Accepts raw HTML strings and renders them inline in Jupyter.
  • Returns status information (success/error) for integration with larger tool flows.
  • Subclass of ToolBase, so it plugs into Swarmauri toolchains seamlessly.

Prerequisites

  • Python 3.10 or newer.
  • Jupyter/IPython environment with display capabilities.

Installation

# pip
pip install swarmauri_tool_jupyterdisplayhtml

# poetry
poetry add swarmauri_tool_jupyterdisplayhtml

# uv (pyproject-based projects)
uv add swarmauri_tool_jupyterdisplayhtml

Quickstart

from swarmauri_tool_jupyterdisplayhtml import JupyterDisplayHTMLTool

tool = JupyterDisplayHTMLTool()
result = tool("""
<h2>Swarmauri</h2>
<p>This HTML was rendered by JupyterDisplayHTMLTool.</p>
""")
print(result)

Tips

  • Wrap the call in Swarmauri agents to surface generated HTML reports or tables.
  • Validate user-provided HTML before rendering to avoid XSS issues in shared notebooks.
  • Combine with other tools that produce HTML (e.g., Folium maps) to display results inline.

Want to help?

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file swarmauri_tool_jupyterdisplayhtml-0.9.0.dev21.tar.gz.

File metadata

  • Download URL: swarmauri_tool_jupyterdisplayhtml-0.9.0.dev21.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for swarmauri_tool_jupyterdisplayhtml-0.9.0.dev21.tar.gz
Algorithm Hash digest
SHA256 8e4a2a114597095ae0738498a4c5d850d4d21eab9670df706ecf6c719bc6424f
MD5 f8faca47fe3086f4473111408d603882
BLAKE2b-256 54730e99dea5ab65e8ba73086d81e25bd79cdfa75530942d3bb72a45214ffcba

See more details on using hashes here.

File details

Details for the file swarmauri_tool_jupyterdisplayhtml-0.9.0.dev21-py3-none-any.whl.

File metadata

  • Download URL: swarmauri_tool_jupyterdisplayhtml-0.9.0.dev21-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for swarmauri_tool_jupyterdisplayhtml-0.9.0.dev21-py3-none-any.whl
Algorithm Hash digest
SHA256 db94be549df67772f833e25e70d453e7dd4374ec9532694f12621e83c822c039
MD5 1114cd96d82b2269e628193fb0f983a1
BLAKE2b-256 8010743a12af290b84d8eaf4f1028ed7abdbd63238e8fae262b7ebf8f2774312

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page