Metadata-Version: 2.3
Name: swarmauri_tool_smogindex
Version: 0.6.0.dev155
Summary: Swarmauri Smog Index 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: 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.dev160,<0.7.0)
Requires-Dist: swarmauri_standard (>=0.6.0.dev155,<0.7.0)
Project-URL: Repository, http://github.com/swarmauri/swarmauri-sdk
Description-Content-Type: text/markdown

![Swarmauri Logo](https://res.cloudinary.com/dbjmpekvl/image/upload/v1730099724/Swarmauri-logo-lockup-2048x757_hww01w.png)

<div align="center">

![PyPI - Downloads](https://img.shields.io/pypi/dm/swarmauri_tool_smogindex)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/swarmauri_tool_smogindex)
![PyPI - License](https://img.shields.io/pypi/l/swarmauri_tool_smogindex)
![PyPI - Version](https://img.shields.io/pypi/v/swarmauri_tool_smogindex?label=swarmauri_tool_smogindex&color=green)

</div>

---

# SMOG Index Tool

A tool for calculating the SMOG (Simple Measure of Gobbledygook) Index of text, which estimates the years of education needed to understand a piece of written material.

## Installation

```bash
pip install swarmauri_tool_smogindex
```

## Usage

```python
from swarmauri.tools.SMOGIndexTool import SMOGIndexTool

# Initialize the tool
tool = SMOGIndexTool()

# Analyze text
text = "This is a sample text with some complex sentences and polysyllabic words to test the SMOG Index calculation."
result = tool(text)

# Get the SMOG index
smog_index = result['smog_index']
print(f"SMOG Index: {smog_index}")  # Output: SMOG Index: 8.5
```

## Want to help?

If you want to contribute to swarmauri-sdk, read up on our [guidelines for contributing](https://github.com/swarmauri/swarmauri-sdk/blob/master/contributing.md) that will help you get started.


