Skip to main content

No project description provided

Project description

textstat-cli-tddschn

Motivation

Get quick and easy readability and other metrics for your texts right on the command line with 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

# 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

$ pip install textstat-cli-tddschn

Usage

$ 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

textstat_cli_tddschn-0.1.1.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

textstat_cli_tddschn-0.1.1-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file textstat_cli_tddschn-0.1.1.tar.gz.

File metadata

  • Download URL: textstat_cli_tddschn-0.1.1.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.3 Darwin/23.4.0

File hashes

Hashes for textstat_cli_tddschn-0.1.1.tar.gz
Algorithm Hash digest
SHA256 bf81b5c38dd1200b6c090c30130326bb0b6dede9d130510ea9f4a478cde19f4e
MD5 95a2ae748cf2d0893d4d01ca0527102c
BLAKE2b-256 df649ca5df1b4c5b9c0637cd59157dbcb0b0a742041cb5e8ff99b8e43361a847

See more details on using hashes here.

File details

Details for the file textstat_cli_tddschn-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for textstat_cli_tddschn-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9e5dc8a383b0c6666d3f2a5948a71e391c94145d3851a8cf193542311902c1ae
MD5 afe842361fa0b070254cc670f2d3a4d2
BLAKE2b-256 35193eeb4eebc4f24e274c525fa75d6b49b830d0697bcbaa4b0105c9160d99ed

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page