swarmauri_tool_folium 0.10.0.dev4

This repository includes an example of a First Class Swarmauri Example.

---

Swarmauri Tool Folium

Generates an interactive Folium map with optional markers and returns the HTML as a base64-encoded string. Designed for embedding maps in Swarmauri workflows or downstream UIs.

Features

• Accepts a map center (lat, lon) plus an optional list of markers (lat, lon, popup).
• Creates a Folium map (HTML) and returns {"image_b64": <base64-html>}.
• Easy to extend with additional Folium layers/tiles by subclassing.

Prerequisites

• Python 3.10 or newer.
• folium (installed automatically).
• Network access if Folium needs to load tiles from external providers at render time.

Installation

# pip
pip install swarmauri_tool_folium

# poetry
poetry add swarmauri_tool_folium

# uv (pyproject-based projects)
uv add swarmauri_tool_folium

Quickstart

import base64
from pathlib import Path
from swarmauri_tool_folium import FoliumTool

map_center = (40.7128, -74.0060)
markers = [(40.7128, -74.0060, "Marker 1"), (40.7328, -74.0010, "Marker 2")]

result = FoliumTool()(map_center, markers)
html_bytes = base64.b64decode(result["image_b64"])
Path("map.html").write_bytes(html_bytes)

Open map.html in a browser to interact with the generated map.

Tips

• Customize map appearance by subclassing and adjusting folium.Map parameters (tiles, zoom_start, etc.).
• Add other Folium layers (heatmaps, choropleths) before saving to build richer visualizations.
• When serving maps via APIs, return the base64 string directly or write to a temporary HTML file and send its path.

Want to help?

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