# textstat-cli-tddschn
- [textstat-cli-tddschn](#textstat-cli-tddschn)
- [Motivation](#motivation)
- [Demo](#demo)
- [Features](#features)
- [Installation](#installation)
- [pipx](#pipx)
- [pip](#pip)
- [Usage](#usage)
- [Develop](#develop)
## Motivation
Get quick and easy readability and other metrics for your texts right on the command line with [`textstat`](https://github.com/textstat/textstat), offering more insights than `wc` and LLM token count.
There's another project on PyPI `textstat-cli` made by another person, I tried that one before making this. Sadly that one doesn't run on my machine, so I made this one.
## Demo
```plain
# Using the tool on my latest blog post at https://teddysc.me/blog/raleigh-menswear-stores-review
$ textstat-cli teddysc.me/data/blog/raleigh-menswear-stores-review.mdx
Metric Value
---------------------------- ------------------
flesch_reading_ease 67.65
flesch_kincaid_grade 6.8
smog_index 8.7
coleman_liau_index 13.38
automated_readability_index 13.7
dale_chall_readability_score 8.12
difficult_words 111
linsear_write_formula 4.7272727272727275
gunning_fog 6.1
text_standard 8th and 9th grade
fernandez_huerta 104.5
szigriszt_pazos 102.97
gutierrez_polini 38.19
crawford 2.1
gulpease_index 52.1
osman 35.41
spache_readability 3.66
mcalpine_eflaw 16.4
reading_time 77.86
syllable_count 1264
lexicon_count 858
sentence_count 71
char_count 5300
letter_count 4669
Explanation of the metircs can be found at https://github.com/textstat/textstat
Please note that some of these metrics are not meant for English texts.
```
## Features
- Lots of metrics, see demo above.
- 3 output formats, table by tabulate (see demo), plain text, or JSON.
## Installation
Requires Python>=3.10, <3.12 (`textstat` requires pkg_resources, which is not available in Python 3.12).
### pipx
This is the recommended installation method.
```
$ pipx install textstat-cli-tddschn
```
### [pip](https://pypi.org/project/textstat-cli-tddschn/)
```
$ pip install textstat-cli-tddschn
```
## Usage
```plain
$ textstat-cli --help
usage: textstat-cli [-h] [-j] [-T] FILE
TextStat (https://github.com/textstat/textstat) CLI
positional arguments:
FILE Input file
options:
-h, --help show this help message and exit
-j, --json Output in JSON format (default: False)
-T, --no-tabulate Do not output in tabulated format (default: False)
```
## Develop
```
$ git clone https://github.com/tddschn/textstat-cli-tddschn.git
$ cd textstat-cli-tddschn
$ poetry install
```
Raw data
{
"_id": null,
"home_page": "https://github.com/tddschn/textstat-cli-tddschn",
"name": "textstat-cli-tddschn",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.10",
"maintainer_email": null,
"keywords": "text, text-analysis, cli, textstat, utility, command-line",
"author": "Teddy Xinyuan Chen",
"author_email": "45612704+tddschn@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/df/64/9ca5df1b4c5b9c0637cd59157dbcb0b0a742041cb5e8ff99b8e43361a847/textstat_cli_tddschn-0.1.1.tar.gz",
"platform": null,
"description": "# textstat-cli-tddschn\n\n- [textstat-cli-tddschn](#textstat-cli-tddschn)\n - [Motivation](#motivation)\n - [Demo](#demo)\n - [Features](#features)\n - [Installation](#installation)\n - [pipx](#pipx)\n - [pip](#pip)\n - [Usage](#usage)\n - [Develop](#develop)\n\n\n## Motivation\n\nGet quick and easy readability and other metrics for your texts right on the command line with [`textstat`](https://github.com/textstat/textstat), offering more insights than `wc` and LLM token count.\n\nThere's another project on PyPI `textstat-cli` made by another person, I tried that one before making this. Sadly that one doesn't run on my machine, so I made this one.\n\n## Demo\n\n```plain\n# Using the tool on my latest blog post at https://teddysc.me/blog/raleigh-menswear-stores-review\n\n$ textstat-cli teddysc.me/data/blog/raleigh-menswear-stores-review.mdx\n\nMetric Value\n---------------------------- ------------------\nflesch_reading_ease 67.65\nflesch_kincaid_grade 6.8\nsmog_index 8.7\ncoleman_liau_index 13.38\nautomated_readability_index 13.7\ndale_chall_readability_score 8.12\ndifficult_words 111\nlinsear_write_formula 4.7272727272727275\ngunning_fog 6.1\ntext_standard 8th and 9th grade\nfernandez_huerta 104.5\nszigriszt_pazos 102.97\ngutierrez_polini 38.19\ncrawford 2.1\ngulpease_index 52.1\nosman 35.41\nspache_readability 3.66\nmcalpine_eflaw 16.4\nreading_time 77.86\nsyllable_count 1264\nlexicon_count 858\nsentence_count 71\nchar_count 5300\nletter_count 4669\n\nExplanation of the metircs can be found at https://github.com/textstat/textstat\n\nPlease note that some of these metrics are not meant for English texts.\n```\n\n## Features\n\n- Lots of metrics, see demo above.\n- 3 output formats, table by tabulate (see demo), plain text, or JSON.\n\n## Installation\n\nRequires Python>=3.10, <3.12 (`textstat` requires pkg_resources, which is not available in Python 3.12).\n\n### pipx\n\nThis is the recommended installation method.\n\n```\n$ pipx install textstat-cli-tddschn\n```\n\n### [pip](https://pypi.org/project/textstat-cli-tddschn/)\n\n```\n$ pip install textstat-cli-tddschn\n```\n\n## Usage\n\n```plain\n$ textstat-cli --help\n\nusage: textstat-cli [-h] [-j] [-T] FILE\n\nTextStat (https://github.com/textstat/textstat) CLI\n\npositional arguments:\n FILE Input file\n\noptions:\n -h, --help show this help message and exit\n -j, --json Output in JSON format (default: False)\n -T, --no-tabulate Do not output in tabulated format (default: False)\n```\n\n## Develop\n\n```\n$ git clone https://github.com/tddschn/textstat-cli-tddschn.git\n$ cd textstat-cli-tddschn\n$ poetry install\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/tddschn/textstat-cli-tddschn/issues",
"Homepage": "https://github.com/tddschn/textstat-cli-tddschn",
"Repository": "https://github.com/tddschn/textstat-cli-tddschn"
},
"split_keywords": [
"text",
" text-analysis",
" cli",
" textstat",
" utility",
" command-line"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "35193eeb4eebc4f24e274c525fa75d6b49b830d0697bcbaa4b0105c9160d99ed",
"md5": "afe842361fa0b070254cc670f2d3a4d2",
"sha256": "9e5dc8a383b0c6666d3f2a5948a71e391c94145d3851a8cf193542311902c1ae"
},
"downloads": -1,
"filename": "textstat_cli_tddschn-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "afe842361fa0b070254cc670f2d3a4d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.10",
"size": 4087,
"upload_time": "2024-05-10T14:31:07",
"upload_time_iso_8601": "2024-05-10T14:31:07.567497Z",
"url": "https://files.pythonhosted.org/packages/35/19/3eeb4eebc4f24e274c525fa75d6b49b830d0697bcbaa4b0105c9160d99ed/textstat_cli_tddschn-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df649ca5df1b4c5b9c0637cd59157dbcb0b0a742041cb5e8ff99b8e43361a847",
"md5": "95a2ae748cf2d0893d4d01ca0527102c",
"sha256": "bf81b5c38dd1200b6c090c30130326bb0b6dede9d130510ea9f4a478cde19f4e"
},
"downloads": -1,
"filename": "textstat_cli_tddschn-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "95a2ae748cf2d0893d4d01ca0527102c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.10",
"size": 3099,
"upload_time": "2024-05-10T14:31:10",
"upload_time_iso_8601": "2024-05-10T14:31:10.200296Z",
"url": "https://files.pythonhosted.org/packages/df/64/9ca5df1b4c5b9c0637cd59157dbcb0b0a742041cb5e8ff99b8e43361a847/textstat_cli_tddschn-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-10 14:31:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tddschn",
"github_project": "textstat-cli-tddschn",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "textstat-cli-tddschn"
}
JSON
