swarmauri_tool_dalechallreadability 0.9.0.dev3__tar.gz → 0.9.0.dev22__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {swarmauri_tool_dalechallreadability-0.9.0.dev3 → swarmauri_tool_dalechallreadability-0.9.0.dev22}/PKG-INFO +53 -12
- swarmauri_tool_dalechallreadability-0.9.0.dev22/README.md +76 -0
- {swarmauri_tool_dalechallreadability-0.9.0.dev3 → swarmauri_tool_dalechallreadability-0.9.0.dev22}/pyproject.toml +14 -1
- swarmauri_tool_dalechallreadability-0.9.0.dev3/README.md +0 -41
- {swarmauri_tool_dalechallreadability-0.9.0.dev3 → swarmauri_tool_dalechallreadability-0.9.0.dev22}/LICENSE +0 -0
- {swarmauri_tool_dalechallreadability-0.9.0.dev3 → swarmauri_tool_dalechallreadability-0.9.0.dev22}/swarmauri_tool_dalechallreadability/DaleChallReadabilityTool.py +0 -0
- {swarmauri_tool_dalechallreadability-0.9.0.dev3 → swarmauri_tool_dalechallreadability-0.9.0.dev22}/swarmauri_tool_dalechallreadability/__init__.py +0 -0
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
2
|
Name: swarmauri_tool_dalechallreadability
|
|
3
|
-
Version: 0.9.0.
|
|
3
|
+
Version: 0.9.0.dev22
|
|
4
4
|
Summary: Swarmauri Community Dale-Chall Readability Tool
|
|
5
|
-
License: Apache-2.0
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
License-File: LICENSE
|
|
7
|
+
Keywords: swarmauri,tool,dalechallreadability,community,dale,chall,readability
|
|
6
8
|
Author: Jacob Stewart
|
|
7
9
|
Author-email: jacob@swarmauri.com
|
|
8
10
|
Requires-Python: >=3.10,<3.13
|
|
@@ -10,14 +12,17 @@ Classifier: License :: OSI Approved :: Apache Software License
|
|
|
10
12
|
Classifier: Programming Language :: Python :: 3.10
|
|
11
13
|
Classifier: Programming Language :: Python :: 3.11
|
|
12
14
|
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Classifier: Natural Language :: English
|
|
16
|
+
Classifier: Development Status :: 3 - Alpha
|
|
17
|
+
Classifier: Intended Audience :: Developers
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
|
|
13
19
|
Requires-Dist: swarmauri_base
|
|
14
20
|
Requires-Dist: swarmauri_core
|
|
15
21
|
Requires-Dist: swarmauri_standard
|
|
16
22
|
Requires-Dist: textstat (>=0.7.4)
|
|
17
23
|
Description-Content-Type: text/markdown
|
|
18
24
|
|
|
19
|
-
|
|
20
|
-
|
|
25
|
+
|
|
21
26
|
|
|
22
27
|
<p align="center">
|
|
23
28
|
<a href="https://pypi.org/project/swarmauri_tool_dalechallreadability/">
|
|
@@ -36,24 +41,60 @@ Description-Content-Type: text/markdown
|
|
|
36
41
|
|
|
37
42
|
# Swarmauri Tool Dale-Chall Readability
|
|
38
43
|
|
|
39
|
-
|
|
44
|
+
Tool wrapper around [`textstat`](https://pypi.org/project/textstat/) to compute the Dale–Chall readability score for a block of text via the Swarmauri tool interface.
|
|
45
|
+
|
|
46
|
+
## Features
|
|
47
|
+
|
|
48
|
+
- Accepts an `input_text` parameter and returns `{"dale_chall_score": <float>}`.
|
|
49
|
+
- Uses `textstat.dale_chall_readability_score` under the hood.
|
|
50
|
+
- Input validation ensures the required parameter is present before calculation.
|
|
51
|
+
|
|
52
|
+
## Prerequisites
|
|
53
|
+
|
|
54
|
+
- Python 3.10 or newer.
|
|
55
|
+
- `textstat` and `pyphen` dictionaries (installed automatically). Some textstat metrics may download additional word lists on first use.
|
|
40
56
|
|
|
41
57
|
## Installation
|
|
42
58
|
|
|
43
59
|
```bash
|
|
60
|
+
# pip
|
|
44
61
|
pip install swarmauri_tool_dalechallreadability
|
|
62
|
+
|
|
63
|
+
# poetry
|
|
64
|
+
poetry add swarmauri_tool_dalechallreadability
|
|
65
|
+
|
|
66
|
+
# uv (pyproject-based projects)
|
|
67
|
+
uv add swarmauri_tool_dalechallreadability
|
|
45
68
|
```
|
|
46
69
|
|
|
47
|
-
##
|
|
48
|
-
|
|
70
|
+
## Quickstart
|
|
71
|
+
|
|
49
72
|
```python
|
|
50
|
-
from
|
|
73
|
+
from swarmauri_tool_dalechallreadability import DaleChallReadabilityTool
|
|
51
74
|
|
|
75
|
+
text = "This is a simple sentence for testing purposes."
|
|
52
76
|
tool = DaleChallReadabilityTool()
|
|
53
|
-
|
|
54
|
-
result
|
|
55
|
-
print(result) # Output: {'dale_chall_score': 7.98}
|
|
77
|
+
result = tool({"input_text": text})
|
|
78
|
+
print(result)
|
|
56
79
|
```
|
|
80
|
+
|
|
81
|
+
## Usage in Tool Chains
|
|
82
|
+
|
|
83
|
+
```python
|
|
84
|
+
from swarmauri_tool_dalechallreadability import DaleChallReadabilityTool
|
|
85
|
+
|
|
86
|
+
def grade_paragraph(paragraph: str) -> float:
|
|
87
|
+
tool = DaleChallReadabilityTool()
|
|
88
|
+
score = tool({"input_text": paragraph})["dale_chall_score"]
|
|
89
|
+
return score
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Tips
|
|
93
|
+
|
|
94
|
+
- Dale–Chall scores roughly map to U.S. grade levels; lower scores indicate easier reading.
|
|
95
|
+
- Pre-clean text (remove markup, normalize whitespace) for consistent scoring.
|
|
96
|
+
- Combine with Swarmauri measurements or parsers to evaluate readability across multiple documents.
|
|
97
|
+
|
|
57
98
|
## Want to help?
|
|
58
99
|
|
|
59
100
|
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.
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<a href="https://pypi.org/project/swarmauri_tool_dalechallreadability/">
|
|
5
|
+
<img src="https://img.shields.io/pypi/dm/swarmauri_tool_dalechallreadability" alt="PyPI - Downloads"/></a>
|
|
6
|
+
<a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_tool_dalechallreadability/">
|
|
7
|
+
<img alt="Hits" src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_tool_dalechallreadability.svg"/></a>
|
|
8
|
+
<a href="https://pypi.org/project/swarmauri_tool_dalechallreadability/">
|
|
9
|
+
<img src="https://img.shields.io/pypi/pyversions/swarmauri_tool_dalechallreadability" alt="PyPI - Python Version"/></a>
|
|
10
|
+
<a href="https://pypi.org/project/swarmauri_tool_dalechallreadability/">
|
|
11
|
+
<img src="https://img.shields.io/pypi/l/swarmauri_tool_dalechallreadability" alt="PyPI - License"/></a>
|
|
12
|
+
<a href="https://pypi.org/project/swarmauri_tool_dalechallreadability/">
|
|
13
|
+
<img src="https://img.shields.io/pypi/v/swarmauri_tool_dalechallreadability?label=swarmauri_tool_dalechallreadability&color=green" alt="PyPI - swarmauri_tool_dalechallreadability"/></a>
|
|
14
|
+
</p>
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
# Swarmauri Tool Dale-Chall Readability
|
|
19
|
+
|
|
20
|
+
Tool wrapper around [`textstat`](https://pypi.org/project/textstat/) to compute the Dale–Chall readability score for a block of text via the Swarmauri tool interface.
|
|
21
|
+
|
|
22
|
+
## Features
|
|
23
|
+
|
|
24
|
+
- Accepts an `input_text` parameter and returns `{"dale_chall_score": <float>}`.
|
|
25
|
+
- Uses `textstat.dale_chall_readability_score` under the hood.
|
|
26
|
+
- Input validation ensures the required parameter is present before calculation.
|
|
27
|
+
|
|
28
|
+
## Prerequisites
|
|
29
|
+
|
|
30
|
+
- Python 3.10 or newer.
|
|
31
|
+
- `textstat` and `pyphen` dictionaries (installed automatically). Some textstat metrics may download additional word lists on first use.
|
|
32
|
+
|
|
33
|
+
## Installation
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
# pip
|
|
37
|
+
pip install swarmauri_tool_dalechallreadability
|
|
38
|
+
|
|
39
|
+
# poetry
|
|
40
|
+
poetry add swarmauri_tool_dalechallreadability
|
|
41
|
+
|
|
42
|
+
# uv (pyproject-based projects)
|
|
43
|
+
uv add swarmauri_tool_dalechallreadability
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Quickstart
|
|
47
|
+
|
|
48
|
+
```python
|
|
49
|
+
from swarmauri_tool_dalechallreadability import DaleChallReadabilityTool
|
|
50
|
+
|
|
51
|
+
text = "This is a simple sentence for testing purposes."
|
|
52
|
+
tool = DaleChallReadabilityTool()
|
|
53
|
+
result = tool({"input_text": text})
|
|
54
|
+
print(result)
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Usage in Tool Chains
|
|
58
|
+
|
|
59
|
+
```python
|
|
60
|
+
from swarmauri_tool_dalechallreadability import DaleChallReadabilityTool
|
|
61
|
+
|
|
62
|
+
def grade_paragraph(paragraph: str) -> float:
|
|
63
|
+
tool = DaleChallReadabilityTool()
|
|
64
|
+
score = tool({"input_text": paragraph})["dale_chall_score"]
|
|
65
|
+
return score
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Tips
|
|
69
|
+
|
|
70
|
+
- Dale–Chall scores roughly map to U.S. grade levels; lower scores indicate easier reading.
|
|
71
|
+
- Pre-clean text (remove markup, normalize whitespace) for consistent scoring.
|
|
72
|
+
- Combine with Swarmauri measurements or parsers to evaluate readability across multiple documents.
|
|
73
|
+
|
|
74
|
+
## Want to help?
|
|
75
|
+
|
|
76
|
+
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.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "swarmauri_tool_dalechallreadability"
|
|
3
|
-
version = "0.9.0.
|
|
3
|
+
version = "0.9.0.dev22"
|
|
4
4
|
description = "Swarmauri Community Dale-Chall Readability Tool"
|
|
5
5
|
license = "Apache-2.0"
|
|
6
6
|
readme = "README.md"
|
|
@@ -11,6 +11,10 @@ classifiers = [
|
|
|
11
11
|
"Programming Language :: Python :: 3.10",
|
|
12
12
|
"Programming Language :: Python :: 3.11",
|
|
13
13
|
"Programming Language :: Python :: 3.12",
|
|
14
|
+
"Natural Language :: English",
|
|
15
|
+
"Development Status :: 3 - Alpha",
|
|
16
|
+
"Intended Audience :: Developers",
|
|
17
|
+
"Topic :: Software Development :: Libraries :: Application Frameworks",
|
|
14
18
|
]
|
|
15
19
|
authors = [{ name = "Jacob Stewart", email = "jacob@swarmauri.com" }]
|
|
16
20
|
dependencies = [
|
|
@@ -19,6 +23,15 @@ dependencies = [
|
|
|
19
23
|
"swarmauri_base",
|
|
20
24
|
"swarmauri_standard",
|
|
21
25
|
]
|
|
26
|
+
keywords = [
|
|
27
|
+
"swarmauri",
|
|
28
|
+
"tool",
|
|
29
|
+
"dalechallreadability",
|
|
30
|
+
"community",
|
|
31
|
+
"dale",
|
|
32
|
+
"chall",
|
|
33
|
+
"readability",
|
|
34
|
+
]
|
|
22
35
|
|
|
23
36
|
[tool.uv.sources]
|
|
24
37
|
swarmauri_core = { workspace = true }
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
<p align="center">
|
|
5
|
-
<a href="https://pypi.org/project/swarmauri_tool_dalechallreadability/">
|
|
6
|
-
<img src="https://img.shields.io/pypi/dm/swarmauri_tool_dalechallreadability" alt="PyPI - Downloads"/></a>
|
|
7
|
-
<a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_tool_dalechallreadability/">
|
|
8
|
-
<img alt="Hits" src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_tool_dalechallreadability.svg"/></a>
|
|
9
|
-
<a href="https://pypi.org/project/swarmauri_tool_dalechallreadability/">
|
|
10
|
-
<img src="https://img.shields.io/pypi/pyversions/swarmauri_tool_dalechallreadability" alt="PyPI - Python Version"/></a>
|
|
11
|
-
<a href="https://pypi.org/project/swarmauri_tool_dalechallreadability/">
|
|
12
|
-
<img src="https://img.shields.io/pypi/l/swarmauri_tool_dalechallreadability" alt="PyPI - License"/></a>
|
|
13
|
-
<a href="https://pypi.org/project/swarmauri_tool_dalechallreadability/">
|
|
14
|
-
<img src="https://img.shields.io/pypi/v/swarmauri_tool_dalechallreadability?label=swarmauri_tool_dalechallreadability&color=green" alt="PyPI - swarmauri_tool_dalechallreadability"/></a>
|
|
15
|
-
</p>
|
|
16
|
-
|
|
17
|
-
---
|
|
18
|
-
|
|
19
|
-
# Swarmauri Tool Dale-Chall Readability
|
|
20
|
-
|
|
21
|
-
A tool for calculating the Dale-Chall Readability Score using the textstat library.
|
|
22
|
-
|
|
23
|
-
## Installation
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
pip install swarmauri_tool_dalechallreadability
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
## Usage
|
|
30
|
-
Basic usage examples with code snippets
|
|
31
|
-
```python
|
|
32
|
-
from swarmauri.tools.DaleChallReadabilityTool import DaleChallReadabilityTool
|
|
33
|
-
|
|
34
|
-
tool = DaleChallReadabilityTool()
|
|
35
|
-
input_data = {"input_text": "This is a simple sentence for testing purposes."}
|
|
36
|
-
result = tool(input_data)
|
|
37
|
-
print(result) # Output: {'dale_chall_score': 7.98}
|
|
38
|
-
```
|
|
39
|
-
## Want to help?
|
|
40
|
-
|
|
41
|
-
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.
|
|
File without changes
|
|
File without changes
|