swarmauri_tool_folium 0.6.0.dev154__tar.gz

swarmauri_tool_folium-0.6.0.dev154/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.3
+Name: swarmauri_tool_folium
+Version: 0.6.0.dev154
+Summary: This repository includes an example of a First Class Swarmauri Example.
+License: Apache-2.0
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: folium (>=0.18.0,<0.19.0)
+Requires-Dist: swarmauri_base (>=0.6.0.dev154,<0.7.0)
+Requires-Dist: swarmauri_core (>=0.6.0.dev154,<0.7.0)
+Project-URL: Repository, http://github.com/swarmauri/swarmauri-sdk
+Description-Content-Type: text/markdown
+
+# Swarmauri Example Community Package

swarmauri_tool_folium-0.6.0.dev154/README.md

@@ -0,0 +1 @@
+# Swarmauri Example Community Package

swarmauri_tool_folium-0.6.0.dev154/pyproject.toml

@@ -0,0 +1,56 @@
+[tool.poetry]
+name = "swarmauri_tool_folium"
+version = "0.6.0.dev154"
+description = "This repository includes an example of a First Class Swarmauri Example."
+authors = ["Jacob Stewart <jacob@swarmauri.com>"]
+license = "Apache-2.0"
+readme = "README.md"
+repository = "http://github.com/swarmauri/swarmauri-sdk"
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12"
+]
+
+[tool.poetry.dependencies]
+python = ">=3.10,<3.13"
+
+# Swarmauri
+swarmauri_core = {version = "^0.6.0.dev154"}
+swarmauri_base = {version = "^0.6.0.dev154"}
+
+# Dependencies
+folium = "^0.18.0"
+
+[tool.poetry.group.dev.dependencies]
+flake8 = "^7.0"
+pytest = "^8.0"
+pytest-asyncio = ">=0.24.0"
+pytest-xdist = "^3.6.1"
+pytest-json-report = "^1.5.0"
+python-dotenv = "*"
+requests = "^2.32.3"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+norecursedirs = ["combined", "scripts"]
+
+markers = [
+    "test: standard test",
+    "unit: Unit tests",
+    "integration: Integration tests",
+    "acceptance: Acceptance tests",
+    "experimental: Experimental tests"
+]
+log_cli = true
+log_cli_level = "INFO"
+log_cli_format = "%(asctime)s [%(levelname)s] %(message)s"
+log_cli_date_format = "%Y-%m-%d %H:%M:%S"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.poetry.plugins."swarmauri.tools"]
+FoliumTool = "swarmauri_tool_folium.FoliumTool:FoliumTool"

swarmauri_tool_folium-0.6.0.dev154/swarmauri_tool_folium/FoliumTool.py

@@ -0,0 +1,78 @@
+# standard/tools/concrete/FoliumTool.py
+import folium
+from typing import List, Tuple, Literal, Dict
+from swarmauri_core.ComponentBase import ComponentBase
+from pydantic import Field
+from swarmauri_base.tools.ToolBase import ToolBase
+from swarmauri_standard.tools.Parameter import Parameter
+import base64
+import io
+
+
+@ComponentBase.register_type(ToolBase, "FoliumTool")
+class FoliumTool(ToolBase):
+    type: Literal["FoliumTool"] = "FoliumTool"
+    name: str = Field("FoliumTool", description="Tool to generate maps using Folium.")
+    description: str = Field(
+        "Generates maps with markers using Folium.",
+        description="Description of the FoliumTool",
+    )
+
+    parameters: List[Parameter] = Field(
+        default_factory=lambda: [
+            Parameter(
+                name="map_center",
+                type="tuple",
+                description="The (latitude, longitude) center of the map.",
+                required=True,
+            ),
+            Parameter(
+                name="markers",
+                type="list",
+                description="A list of (latitude, longitude, popup) tuples for markers.",
+                required=False,
+                default=[],
+            ),
+        ]
+    )
+
+    def __call__(
+        self,
+        map_center: Tuple[float, float],
+        markers: List[Tuple[float, float, str]],
+    ) -> Dict[str, str]:
+        """
+        Generate a folium map with markers and return the map as a base64-encoded image.
+
+        Parameters:
+        map_center (Tuple[float, float]): Latitude and longitude for the map's center.
+        markers (List[Tuple[float, float, str]]): A list of markers, where each marker is a tuple containing latitude,
+                                              longitude, and popup text.
+
+        Returns:
+        Dict[str, str]: A dictionary containing the base64-encoded image of the generated map, with the key 'image_b64'.
+
+        Example:
+        >>> tool = FoliumTool()
+        >>> map_center = (40.7128, -74.0060)
+        >>> markers = [(40.7128, -74.0060, "Marker 1"), (40.7328, -74.0010, "Marker 2")]
+        >>> result = tool(map_center, markers)
+        >>> print(result['image_b64'])  # Prints the base64 string of the map image
+        """
+        # Generate the folium map
+        map_ = folium.Map(location=map_center, zoom_start=13)
+
+        # Add markers to the map
+        for lat, lon, popup in markers:
+            folium.Marker(location=[lat, lon], popup=popup).add_to(map_)
+
+        # Save the map to an in-memory BytesIO object
+        map_img = io.BytesIO()
+        map_.save(map_img, close_file=False)
+
+        # Encode the map as base64
+        map_img.seek(0)  # Go to the beginning of the BytesIO object
+        map_b64 = base64.b64encode(map_img.getvalue()).decode("utf-8")
+
+        # Return the encoded map as a base64 string
+        return {"image_b64": map_b64}

swarmauri_tool_folium-0.6.0.dev154/swarmauri_tool_folium/__init__.py

@@ -0,0 +1,14 @@
+from .FoliumTool import FoliumTool
+
+__version__ = "0.6.0.dev26"
+__long_desc__ = """
+
+# Swarmauri Folium Plugin
+
+This repository includes a Folium of a Swarmauri Plugin.
+
+Visit us at: https://swarmauri.com
+Follow us at: https://github.com/swarmauri
+Star us at: https://github.com/swarmauri/swarmauri-sdk
+
+"""