swarmauri_tool_dalechallreadability 0.6.0.dev154__py3-none-any.whl

swarmauri_tool_dalechallreadability/DaleChallReadabilityTool.py

@@ -0,0 +1,66 @@
+from swarmauri_core.ComponentBase import ComponentBase
+import textstat
+from typing import Any, Dict, List, Literal
+from swarmauri_base.tools.ToolBase import ToolBase
+from swarmauri_standard.tools.Parameter import Parameter
+
+
+@ComponentBase.register_type(ToolBase, "DaleChallReadabilityTool")
+class DaleChallReadabilityTool(ToolBase):
+    """
+    A tool for calculating the Dale-Chall Readability Score using the textstat library.
+
+    Attributes:
+        version (str): The version of the tool.
+        name (str): The name of the tool.
+        type (Literal["DaleChallReadabilityTool"]): The type of the tool.
+        description (str): A brief description of what the tool does.
+    """
+
+    version: str = "0.1.dev1"
+    name: str = "DaleChallReadabilityTool"
+    type: Literal["DaleChallReadabilityTool"] = "DaleChallReadabilityTool"
+    description: str = (
+        "Calculates the Dale-Chall Readability Score for a given text using textstat."
+    )
+    parameters: List[Parameter] = [
+        Parameter(
+            name="input_text",
+            type="string",
+            description="The input text for which to calculate the Dale-Chall Readability Score.",
+            required=True,
+        )
+    ]
+
+    def __call__(self, data: Dict[str, Any]) -> Dict[str, float]:
+        """
+        Executes the Dale-Chall Readability tool and returns the readability score using textstat.
+
+        Parameters:
+            data (Dict[str, Any]): The input data containing "input_text".
+
+        Returns:
+            Dict[str, float]: A dictionary containing the Dale-Chall Readability Score
+
+        Raises:
+            ValueError: If the input data is invalid.
+        """
+        if self.validate_input(data):
+            text = data["input_text"]
+            dale_chall_score = textstat.dale_chall_readability_score(text)
+            return {"dale_chall_score": dale_chall_score}
+        else:
+            raise ValueError("Invalid input for DaleChallReadabilityTool.")
+
+    def validate_input(self, data: Dict[str, Any]) -> bool:
+        """
+        Validates the input data.
+
+        Parameters:
+            data (Dict[str, Any]): The input data to be validated.
+
+        Returns:
+            bool: True if the input data is valid, False otherwise.
+        """
+        required_keys = ["input_text"]
+        return all(key in data for key in required_keys)

swarmauri_tool_dalechallreadability/__init__.py

@@ -0,0 +1,13 @@
+# swm_example_community_package/__init__.py
+__version__ = "0.6.0.dev26"
+__long_desc__ = """
+
+# Swarmauri Example Plugin
+
+This repository includes an example 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
+
+"""

swarmauri_tool_dalechallreadability-0.6.0.dev154.dist-info/METADATA

@@ -0,0 +1,20 @@
+Metadata-Version: 2.3
+Name: swarmauri_tool_dalechallreadability
+Version: 0.6.0.dev154
+Summary: Swarmauri Community Dale-Chall Readability Tool
+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: swarmauri_base (>=0.6.0.dev154,<0.7.0)
+Requires-Dist: swarmauri_core (>=0.6.0.dev154,<0.7.0)
+Requires-Dist: textstat (>=0.7.4,<0.8.0)
+Project-URL: Repository, http://github.com/swarmauri/swarmauri-sdk
+Description-Content-Type: text/markdown
+
+# Swarmauri Example Community Package

swarmauri_tool_dalechallreadability-0.6.0.dev154.dist-info/RECORD

@@ -0,0 +1,6 @@
+swarmauri_tool_dalechallreadability/__init__.py,sha256=0uVHnLXq2It40mWLDInnCTPWZurTYLYZsSMwQBwziQM,332
+swarmauri_tool_dalechallreadability/DaleChallReadabilityTool.py,sha256=mEErX4ec3KXeXwP8LaoikMGUa-GlYVO8blkoROHkLcg,2427
+swarmauri_tool_dalechallreadability-0.6.0.dev154.dist-info/entry_points.txt,sha256=l5wn5PRbhwm8Frb5PXk2vhF0Li9zziXuiVjB_JjKxFM,130
+swarmauri_tool_dalechallreadability-0.6.0.dev154.dist-info/METADATA,sha256=Xr1sXncyW9RbPhYUQD7KC8ViRKtE_tce_es3vO7P9MQ,808
+swarmauri_tool_dalechallreadability-0.6.0.dev154.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+swarmauri_tool_dalechallreadability-0.6.0.dev154.dist-info/RECORD,,

swarmauri_tool_dalechallreadability-0.6.0.dev154.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.0.1
+Root-Is-Purelib: true
+Tag: py3-none-any

swarmauri_tool_dalechallreadability-0.6.0.dev154.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[swarmauri.tools]
+DaleChallReadabilityTool=swarmauri_tool_dalechallreadability.DaleChallReadabilityTool:DaleChallReadabilityTool
+