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.3.dev17.tar.gz.

File metadata

  • Download URL: swarmauri_tool_jupyterdisplayhtml-0.9.3.dev17.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.9.3.dev17.tar.gz
Algorithm Hash digest
SHA256 53e32bb173a7dcb9bc265c5429f8ad2eed88638169bd3dc1e318a10d1fceafe5
MD5 b75e573ad61cb7e4267c38ced98ed154
BLAKE2b-256 7f3ee33a406ffe91d8cb85cc4b2201a1ea2d0dd276c6731063a5d931572459b7

See more details on using hashes here.

File details

Details for the file swarmauri_tool_jupyterdisplayhtml-0.9.3.dev17-py3-none-any.whl.

File metadata

  • Download URL: swarmauri_tool_jupyterdisplayhtml-0.9.3.dev17-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.9.3.dev17-py3-none-any.whl
Algorithm Hash digest
SHA256 af54dd6fd62ef0b9a4a22eb6094b48e5555025d06f7fd07dea9bf2b1ed7c6c52
MD5 3516ddcc7696abab468e38cd94a82be7
BLAKE2b-256 3dbfc996ecdda9ce68b2477b46d794a3aa93e23ecb7b61aec8b65e89236720c7

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