swarmauri_tool_lexicaldensity 0.6.0.dev154__tar.gz

swarmauri_tool_lexicaldensity-0.6.0.dev154/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.3
+Name: swarmauri_tool_lexicaldensity
+Version: 0.6.0.dev154
+Summary: Lexical Density Tool for Swarmauri.
+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: nltk (>=3.9.1,<4.0.0)
+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_lexicaldensity-0.6.0.dev154/README.md

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

swarmauri_tool_lexicaldensity-0.6.0.dev154/pyproject.toml

@@ -0,0 +1,58 @@
+[tool.poetry]
+name = "swarmauri_tool_lexicaldensity"
+version = "0.6.0.dev154"
+description = "Lexical Density Tool for Swarmauri."
+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
+textstat = "^0.7.4"
+nltk = "^3.9.1"
+
+
+[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"]
+LexicalDensityTool = "swarmauri_tool_lexicaldensity.LexicalDensityTool:LexicalDensityTool"

swarmauri_tool_lexicaldensity-0.6.0.dev154/swarmauri_tool_lexicaldensity/LexicalDensityTool.py

@@ -0,0 +1,103 @@
+import nltk
+from swarmauri_core.ComponentBase import ComponentBase
+import textstat
+from typing import List, Literal, Dict
+from pydantic import Field
+from swarmauri_base.tools.ToolBase import ToolBase
+from swarmauri_standard.tools.Parameter import Parameter
+
+# Download necessary NLTK resources
+nltk.download("punkt_tab")
+nltk.download("averaged_perceptron_tagger_eng")
+
+
+@ComponentBase.register_type(ToolBase, "LexicalDensityTool")
+class LexicalDensityTool(ToolBase):
+    version: str = "0.1.dev2"
+    parameters: List[Parameter] = Field(
+        default_factory=lambda: [
+            Parameter(
+                name="text",
+                type="string",
+                description="The text for which to calculate the Lexical Density.",
+                required=True,
+            )
+        ]
+    )
+
+    name: str = "LexicalDensityTool"
+    description: str = (
+        "Calculates the lexical density of a text, indicating the proportion of lexical words."
+    )
+    type: Literal["LexicalDensityTool"] = "LexicalDensityTool"
+
+    def __call__(self, text: str) -> Dict[str, float]:
+        """
+        Calculates the Lexical Density score for the given text.
+
+        Parameters:
+        - text (str): The text to analyze.
+
+        Returns:
+        - Dict[str, float]: A dictionary containing the Lexical Density score.
+        """
+        return {"lexical_density": self.calculate_lexical_density(text)}
+
+    def calculate_lexical_density(self, text: str) -> float:
+        """
+        Calculates the Lexical Density score for the given text.
+
+        Args:
+            text (str): The text to analyze.
+
+        Returns:
+            float: The Lexical Density score as a percentage.
+        """
+        # Total number of words in the text
+        total_words = textstat.lexicon_count(text, removepunct=True)
+
+        # Total number of lexical words (content words)
+        lexical_words = self.count_lexical_words(text)
+
+        # Calculate lexical density
+        if total_words == 0:
+            return 0.0
+
+        lexical_density = (lexical_words / total_words) * 100
+        return lexical_density
+
+    def count_lexical_words(self, text: str) -> int:
+        """
+        Counts the number of lexical words (nouns, verbs, adjectives, adverbs) in the text.
+
+        Args:
+            text (str): The text to analyze.
+
+        Returns:
+            int: The number of lexical words in the text.
+        """
+        words = nltk.word_tokenize(text)
+        pos_tags = nltk.pos_tag(words)
+
+        # POS tags for lexical words (nouns, verbs, adjectives, adverbs)
+        lexical_pos_tags = {
+            "NN",
+            "NNS",
+            "NNP",
+            "NNPS",
+            "VB",
+            "VBD",
+            "VBG",
+            "VBN",
+            "VBP",
+            "VBZ",
+            "JJ",
+            "JJR",
+            "JJS",
+            "RB",
+            "RBR",
+            "RBS",
+        }
+
+        lexical_words = [word for word, pos in pos_tags if pos in lexical_pos_tags]
+        return len(lexical_words)

swarmauri_tool_lexicaldensity-0.6.0.dev154/swarmauri_tool_lexicaldensity/__init__.py

@@ -0,0 +1,14 @@
+from .LexicalDensityTool import LexicalDensityTool
+
+__version__ = "0.6.0.dev26"
+__long_desc__ = """
+
+# Swarmauri LexicalDensity Plugin
+
+This repository includes a LexicalDensity 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
+
+"""