swarmauri_tool_smogindex 0.11.0.dev1

Swarmauri readability-analysis tool for calculating SMOG Index scores across text and documentation.

Swarmauri Tool SMOG Index

swarmauri_tool_smogindex is a Swarmauri readability tool for calculating the SMOG Index, a well-known estimate of the education level needed to understand a piece of writing. It is useful for compliance content, educational materials, technical documentation, public-facing copy, and agent workflows that need a quick readability score.

Why Use Swarmauri Tool SMOG Index

• Estimate how difficult a text may be for readers to understand.
• Review whether copy meets documentation or policy readability targets.
• Add grade-level signals to editorial, education, or governance workflows.
• Compare document revisions with a consistent, interpretable metric.

FAQ

What does the tool return?
A dictionary with one key: smog_index.

How is the score estimated?
The implementation counts sentences and polysyllabic words, then applies the standard SMOG formula.

What happens for empty text?
The score returns 0.0 when no sentences are found.

Is this a full readability suite?
No. It focuses specifically on the SMOG Index.

Features

• Swarmauri ToolBase implementation registered as SMOGIndexTool.
• Calculates SMOG readability scores from raw text.
• Uses sentence tokenization plus polysyllable counting.
• Useful for document QA, public-language review, and education use cases.
• Supports Python 3.10, 3.11, 3.12, 3.13, and 3.14.

Installation

uv add swarmauri_tool_smogindex

pip install swarmauri_tool_smogindex

Usage

from swarmauri_tool_smogindex import SMOGIndexTool

tool = SMOGIndexTool()
result = tool("This is a sample text with complex sentences and polysyllabic words.")

print(result["smog_index"])

Examples

Score a policy document excerpt

from swarmauri_tool_smogindex import SMOGIndexTool

tool = SMOGIndexTool()
score = tool("Authentication requirements shall be enforced through administrative verification procedures.")

print(score)

Compare simplified and technical versions

from swarmauri_tool_smogindex import SMOGIndexTool

tool = SMOGIndexTool()

simple = "Read the guide and follow the steps."
technical = "Operational remediation requires synchronized configuration validation across administrative boundaries."

print("simple", tool(simple))
print("technical", tool(technical))

Register the tool in a Swarmauri collection

from swarmauri_standard.tools.ToolCollection import ToolCollection
from swarmauri_tool_smogindex import SMOGIndexTool

tools = ToolCollection(tools=[SMOGIndexTool()])
print(tools)

Related Packages

• swarmauri_tool_dalechallreadability
• swarmauri_tool_sentencecomplexity
• swarmauri_tool_lexicaldensity
• swarmauri_tool_textlength

Swarmauri Foundations

• swarmauri
• swarmauri_core
• swarmauri_base
• swarmauri_standard

More Documentation

• SMOG formula overview
• NLTK documentation
• Swarmauri SDK repository

Best Practices

• Use the score comparatively across similar kinds of content.
• Expect very short texts to produce less stable readability estimates.
• Pre-download tokenizer resources in offline deployments.
• Pair SMOG with other readability and structure metrics for better judgment.

License

This project is licensed under the Apache-2.0 License.