Textatistic
===========
Textatistic is a Python package to calculate the `Flesch Reading Ease <https://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests>`_, `Flesch-Kincaid <https://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests>`_, `Gunning Fog <https://en.wikipedia.org/wiki/Gunning_fog_index>`_, `Simple Measure of Gobbledygook <https://en.wikipedia.org/wiki/SMOG>`_ (SMOG) and `Dale-Chall <http://www.readabilityformulas.com/new-dale-chall-readability-formula.php>`_ readability indices. Textatistic also contains functions to count the number of sentences, characters, syllables, words, words with three or more syllables and words on an expanded Dale-Chall list of easy words.
Installation
------------
.. code-block:: bash
$ pip install textatistic
Documentation
-------------
Detailed documentation available at `erinhengel.com <http://www.erinhengel.com/software/textatistic/>`_.
Quickstart
----------
.. code-block:: python
>>> from textatistic import Textatistic
# Generate object of readability statistics.
>>> text = 'There was a king with a large jaw. There was a queen with a plain face.'
>>> s = Textatistic(text)
# Return sentence count.
>>> s.sent_count
2
# Return Flesch Reading Ease score.
>>> s.flesch_score
114.11500000000001
# Return dictionary of character/word/syllable counts.
>>> s.counts
...
# Return dictionary of readability scores.
>>> s.scores
...
# Return dictionary of all attribute values.
>>> s.dict()
...
Table of attributes
+++++++++++++++++++
+-------------------------+-----------------------------------------------------------------------------------+
| ``char_count`` | number of non-space characters. |
+-------------------------+-----------------------------------------------------------------------------------+
| ``notdalechall_count`` | number of words not on Dale-Chall list of words understood by 80% of 4th graders. |
+-------------------------+-----------------------------------------------------------------------------------+
| ``polysyblword_count`` | number of words with three or more syllables. |
+-------------------------+-----------------------------------------------------------------------------------+
| ``sent_count`` | number of sentences. |
+-------------------------+-----------------------------------------------------------------------------------+
| ``sybl_count`` | number of syllables. |
+-------------------------+-----------------------------------------------------------------------------------+
| ``word_count`` | number of words. |
+-------------------------+-----------------------------------------------------------------------------------+
| ``dalechall_score`` | Dale-Chall score. |
+-------------------------+-----------------------------------------------------------------------------------+
| ``flesch_score`` | Flesch Reading Ease score. |
+-------------------------+-----------------------------------------------------------------------------------+
| ``fleschkincaid_score`` | Flesch-Kincaid score. |
+-------------------------+-----------------------------------------------------------------------------------+
| ``gunningfog_score`` | Gunning Fog score. |
+-------------------------+-----------------------------------------------------------------------------------+
| ``smog_score`` | SMOG score. |
+-------------------------+-----------------------------------------------------------------------------------+
Raw data
{
"_id": null,
"home_page": "http://www.erinhengel.com/software/textatistic/",
"name": "textatistic",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Erin Hengel",
"author_email": "erin.hengel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/73/f8/74dade1df8998ce9a42cba21b3cdf284f3f273e7e22fbcab27955d213e61/textatistic-0.0.1.tar.gz",
"platform": "UNKNOWN",
"description": "Textatistic\n===========\n\nTextatistic is a Python package to calculate the `Flesch Reading Ease <https://en.wikipedia.org/wiki/Flesch\u2013Kincaid_readability_tests>`_, `Flesch-Kincaid <https://en.wikipedia.org/wiki/Flesch\u2013Kincaid_readability_tests>`_, `Gunning Fog <https://en.wikipedia.org/wiki/Gunning_fog_index>`_, `Simple Measure of Gobbledygook <https://en.wikipedia.org/wiki/SMOG>`_ (SMOG) and `Dale-Chall <http://www.readabilityformulas.com/new-dale-chall-readability-formula.php>`_ readability indices. Textatistic also contains functions to count the number of sentences, characters, syllables, words, words with three or more syllables and words on an expanded Dale-Chall list of easy words.\n\n\nInstallation\n------------\n\t\n.. code-block:: bash\n\n\t$ pip install textatistic\n\n\nDocumentation\n-------------\n\nDetailed documentation available at `erinhengel.com <http://www.erinhengel.com/software/textatistic/>`_. \n\n\nQuickstart\n----------\n\n.. code-block:: python\n\n\t>>> from textatistic import Textatistic\n\t\n\t# Generate object of readability statistics.\n\t>>> text = 'There was a king with a large jaw. There was a queen with a plain face.'\n\t>>> s = Textatistic(text)\n\t\n\t# Return sentence count.\n\t>>> s.sent_count\n\t2\n\t\n\t# Return Flesch Reading Ease score.\n\t>>> s.flesch_score\n\t114.11500000000001\n\t\n\t# Return dictionary of character/word/syllable counts.\n\t>>> s.counts\n\t...\n\t\n\t# Return dictionary of readability scores.\n\t>>> s.scores\n\t...\n\t\n\t# Return dictionary of all attribute values.\n\t>>> s.dict()\n\t...\n\n\nTable of attributes\n+++++++++++++++++++\n\n+-------------------------+-----------------------------------------------------------------------------------+ \n| ``char_count`` | number of non-space characters. | \n+-------------------------+-----------------------------------------------------------------------------------+\n| ``notdalechall_count`` | number of words not on Dale-Chall list of words understood by 80% of 4th graders. | \n+-------------------------+-----------------------------------------------------------------------------------+\n| ``polysyblword_count`` | number of words with three or more syllables. | \n+-------------------------+-----------------------------------------------------------------------------------+\n| ``sent_count`` | number of sentences. | \n+-------------------------+-----------------------------------------------------------------------------------+\n| ``sybl_count`` | number of syllables. | \n+-------------------------+-----------------------------------------------------------------------------------+\n| ``word_count`` | number of words. | \n+-------------------------+-----------------------------------------------------------------------------------+\n| ``dalechall_score`` | Dale-Chall score. | \n+-------------------------+-----------------------------------------------------------------------------------+\n| ``flesch_score`` | Flesch Reading Ease score. | \n+-------------------------+-----------------------------------------------------------------------------------+\n| ``fleschkincaid_score`` | Flesch-Kincaid score. | \n+-------------------------+-----------------------------------------------------------------------------------+\n| ``gunningfog_score`` | Gunning Fog score. | \n+-------------------------+-----------------------------------------------------------------------------------+\n| ``smog_score`` | SMOG score. | \n+-------------------------+-----------------------------------------------------------------------------------+\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Calculate readability scores (Flesch Reading Ease, etc.).",
"version": "0.0.1",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "http://www.erinhengel.com/software/textatistic/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "73f874dade1df8998ce9a42cba21b3cdf284f3f273e7e22fbcab27955d213e61",
"md5": "ffd34f53a890ada8ec9d619456f22b36",
"sha256": "281dec67821ab43833e0f7ed846b7931ef4f8a88efc18930339481f5a9e4d62f"
},
"downloads": -1,
"filename": "textatistic-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "ffd34f53a890ada8ec9d619456f22b36",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29941,
"upload_time": "2015-10-25T13:03:04",
"upload_time_iso_8601": "2015-10-25T13:03:04.062406Z",
"url": "https://files.pythonhosted.org/packages/73/f8/74dade1df8998ce9a42cba21b3cdf284f3f273e7e22fbcab27955d213e61/textatistic-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2015-10-25 13:03:04",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "textatistic"
}
JSON