smoothtext 0.0.17

SmoothText is a Python library for calculating readability scores of texts and statistical information for texts in multiple languages.

SmoothText

---

---

SmoothText is still in alpha and there may be breaking changes.

---

Introduction

SmoothText is a Python library for calculating readability scores of texts and statistical information for texts in multiple languages.

The design principle of this library is to ensure high accuracy.

Requirements

Python 3.10 or higher.

External Dependencies

Library	Version	License	Notes
NLTK	>=3.9.1	Apache 2.0	Conditionally optional.
Stanza	>=1.10.1	Apache 2.0	Conditionally optional.
Unidecode	>=1.3.8	GNU GPLv2	Required.
Pyphen	>=0.17.0	GPL 2.0+/LGPL 2.1+/MPL 1.1	Required.

Either NLTK or Stanza must be installed and used with the SmoothText library.

Features

Readability Analysis

SmoothText can calculate readability scores of text in the following languages, using the following formulas.

Formula/Language	English	Turkish
Flesch Reading Ease	✔	✔ Ateşman
Flesch-Kincaid Grade	✔	✔ Bezirci-Yılmaz
Flesch-Kincaid Grade Simplified	✔	❌

Notes:

• Ateşman is the Turkish adaptation of Flesch Reading Ease. The two can be used interchangeably in the module.
• Bezirci-Yılmaz is the Turkish adaptation of Flesch-Kincaid Grade. The two can be used interchangeably in the module.
• Flesch-Kincaid Grade Simplified is essentially the same formula with as Flesch-Kincaid Grade, except that its constants are different.

Sentencizing, Tokenizing, and Syllabifying

SmoothText can extract sentences, words, or syllables from texts.

Reading Time

SmoothText can calculate how long would a text take to read.

Installation

You can install SmoothText via pip.

pip
install
smoothtext

Usage

Importing and Initializing the Library

SmoothText comes with three submodules: Language, ReadabilityFormula and SmoothText.

from smoothtext import Language, ReadabilityFormula, SmoothText

Before using, the library must be initialized with a static function. The following will set NLTK as the backend, and automatically download all the resources for the supported languages. Alternatively, you can use Stanza.

SmoothText.setup(backend='nltk')

Instancing

SmoothText is expected to be used with SmoothText class instances.

st = SmoothText('en')

Now, an instance is accessible via st, and it is ready to work with English texts.

Calculating Readability Scores

See the following text. Now, we will analyze it.

text = "Forrest Gump is a 1994 American comedy-drama film directed by Robert Zemeckis."

For English, we have two available formulas: Flesch Reading Ease and Flesch-Kincaid Grade. We can either call the compute_readability function, or use the instance as a callable. Either way, we are expected to pass the formula.

score_1 = st.compute_readability(text, ReadabilityFormula.Flesch_Reading_Ease)
score_2 = st(text, ReadabilityFormula.Flesch_Kincaid_Grade)

print(score_1, score_2)
# Output is: 25.455000000000013 12.690000000000001

Documentation

See here for API documentation.

Roadmap

SmoothText is still in its early stages. The immediate tasks include adding more languages and backends.

License

SmoothText has an MIT license. See LICENSE.