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.10.0.dev5.tar.gz.

File metadata

  • Download URL: swarmauri_tool_jupyterdisplayhtml-0.10.0.dev5.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","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.10.0.dev5.tar.gz
Algorithm Hash digest
SHA256 427d1fe9c268c99f86120dfe7b1f6eab1609e617501404f097567c48487a3956
MD5 1ece17d1d9a55b853dae4b85137246f2
BLAKE2b-256 2f68e0f6dad8b12f9b1298890c6b294f2fdec3e6ffc7f18bc5191aff09887f0a

See more details on using hashes here.

File details

Details for the file swarmauri_tool_jupyterdisplayhtml-0.10.0.dev5-py3-none-any.whl.

File metadata

  • Download URL: swarmauri_tool_jupyterdisplayhtml-0.10.0.dev5-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","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.10.0.dev5-py3-none-any.whl
Algorithm Hash digest
SHA256 335b5076181900f1cff7af79debcb3935d073727aaa6cbdfd59a2aaf5cb9fcd6
MD5 57ee4de54f3ef894f85373ca882c0ae0
BLAKE2b-256 3a8b83e21bf9a219367fd7f09c2ecbaf6c195ec86329d6c7798a0230eebd3bba

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