Metadata-Version: 2.4
Name: swarmauri_tool_smogindex
Version: 0.9.3.dev5
Summary: Swarmauri Smog Index Tool.
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: swarmauri,tool,smogindex,smog,index
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.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Natural Language :: English
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Dist: nltk (>=3.9.1)
Requires-Dist: swarmauri_base
Requires-Dist: swarmauri_core
Requires-Dist: swarmauri_standard
Requires-Dist: transformers (>=4.45.0)
Description-Content-Type: text/markdown


![Swarmauri Logo](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)

<p align="center">
    <a href="https://pypi.org/project/swarmauri_tool_smogindex/">
        <img src="https://img.shields.io/pypi/dm/swarmauri_tool_smogindex" alt="PyPI - Downloads"/></a>
    <a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_tool_smogindex/">
        <img alt="Hits" src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_tool_smogindex.svg"/></a>
    <a href="https://pypi.org/project/swarmauri_tool_smogindex/">
        <img src="https://img.shields.io/pypi/pyversions/swarmauri_tool_smogindex" alt="PyPI - Python Version"/></a>
    <a href="https://pypi.org/project/swarmauri_tool_smogindex/">
        <img src="https://img.shields.io/pypi/l/swarmauri_tool_smogindex" alt="PyPI - License"/></a>
    <a href="https://pypi.org/project/swarmauri_tool_smogindex/">
        <img src="https://img.shields.io/pypi/v/swarmauri_tool_smogindex?label=swarmauri_tool_smogindex&color=green" alt="PyPI - swarmauri_tool_smogindex"/></a>
</p>

---

# Swarmauri Tool Smog Index

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.


