v1.3.7

v1.3.7 (2023-10-28)

Fix

• deps: bump syllables from 1.0.8 to 1.0.9 (#64)
• deps: bump syllables from 1.0.8 to 1.0.9

[main 02d7a21] bump: 1.3.6 → 1.3.7
2 files changed, 9 insertions(+), 2 deletions(-)

v1.3.6

v1.3.6 (2023-10-15)

Fix

• deps: bump cmudict from 1.0.13 to 1.0.15
• deps: bump syllables from 1.0.7 to 1.0.8

[main cf9053b] bump: 1.3.5 → 1.3.6
2 files changed, 9 insertions(+), 2 deletions(-)

v1.3.5

v1.3.5 (2022-12-19)

Fix

• added commitizen config
• explicit ci jobs
• publish on tag v
• added release workflow

[main 15488ea] bump: 1.3.4 → 1.3.5
2 files changed, 36 insertions(+), 2 deletions(-)
create mode 100644 CHANGELOG.md

v1.3.4

1.3.4 (2022-12-11)

v1.3.3

Fixed

• cli restored by adding missing entry_points in setup.cfg

v1.3.2

Package Maintenance

Added

GitHub Actions

• test pypi publishing on tag
• build check with twine during CI

Changed

• use black
• use pylint
• retire Codacy
• use current packaging practices
  • added pyproject.toml
  • moved static settings to setup.cfg

v1.3.1

Changed

• cli updates thanks to @slingload
  • cli now accepts multiple files for analysis:

  Usage: prosegrinder [OPTIONS] FILES...
  
    Setup the command line interface
  
  Options:
    -i, --indent INTEGER  Python pretty-print json indent level.
    -s, --save FILENAME   File to save output to.
    --help                Show this message and exit.

  • cli produces and array of analysis results:

  [
    {
      "filename": "shortstory.txt",
      "statistics": {
        "sha256": "5b756dea7c7f0088ff3692e402466af7f4fc493fa357c1ae959fa4493943fc03",
        "word_character_count": 7008,
        "phone_count": 5747,
        "syllable_count": 2287,
        "word_count": 1528,
        "sentence_count": 90,
        "paragraph_count": 77,
        "complex_word_count": 202,
        "long_word_count": 275,
        "pov_word_count": 113,
        "first_person_word_count": 8,
        "second_person_word_count": 74,
        "third_person_word_count": 31,
        "pov": "first",
        "readability_scores": {
          "automated_readability_index": 0.281,
          "coleman_liau_index": 9.425,
          "flesch_kincaid_grade_level": 8.693,
          "flesch_reading_ease": 62.979,
          "gunning_fog_index": 12.079,
          "linsear_write": 10.733,
          "lix": 34.975,
          "rix": 3.056,
          "smog": 11.688
        }
      }
    },
    {
      "filename": "copyright.txt",
      "statistics": {
        "sha256": "553bfd087a2736e4bbe2f312e3d3a5b763fb57caa54e3626da03b0fd3f42e017",
        "word_character_count": 222,
        "phone_count": 169,
        "syllable_count": 78,
        "word_count": 46,
        "sentence_count": 7,
        "paragraph_count": 16,
        "complex_word_count": 10,
        "long_word_count": 12,
        "pov_word_count": 1,
        "first_person_word_count": 1,
        "second_person_word_count": 0,
        "third_person_word_count": 0,
        "pov": "first",
        "readability_scores": {
          "automated_readability_index": 1.404,
          "coleman_liau_index": 8.073,
          "flesch_kincaid_grade_level": 6.982,
          "flesch_reading_ease": 56.713,
          "gunning_fog_index": 11.324,
          "linsear_write": 3.714,
          "lix": 32.658,
          "rix": 1.714,
          "smog": 9.957
        }
      }
    }
  ]

v1.3.0

Added

• added stats property to Prose
• added simple cli test

Changed

• cli output updated to reflect stats property on Prose:

{
  "filename": "shortstory.txt",
  "statistics": {
    "sha256": "5b756dea7c7f0088ff3692e402466af7f4fc493fa357c1ae959fa4493943fc03",
    "word_character_count": 7008,
    "phone_count": 5747,
    "syllable_count": 2287,
    "word_count": 1528,
    "sentence_count": 90,
    "paragraph_count": 77,
    "complex_word_count": 202,
    "long_word_count": 275,
    "pov_word_count": 113,
    "first_person_word_count": 8,
    "second_person_word_count": 74,
    "third_person_word_count": 31,
    "pov": "first",
    "readability_scores": {
      "automated_readability_index": 0.281,
      "coleman_liau_index": 9.425,
      "flesch_kincaid_grade_level": 8.693,
      "flesch_reading_ease": 62.979,
      "gunning_fog_index": 12.079,
      "linsear_write": 10.733,
      "lix": 34.975,
      "rix": 3.056,
      "smog": 11.688
    }
  }
}

Removed

• removed property annotations from all objects

v1.2.0

Added

Added a simple CLI:

Usage: prosegrinder [OPTIONS] FILE

Options:
  -s, --save FILENAME
  -i, --indent INTEGER
  --help                Show this message and exit.

Provides basic statistics on text from a file, the filename, and the sh256 of text analyzed. Output is json to help facilitate use in automation:

{
  "filename": "./tests/resources/shortstory.txt",
  "sha256": "5b756dea7c7f0088ff3692e402466af7f4fc493fa357c1ae959fa4493943fc03",
  "word_character_count": 7008,
  "phone_count": 5747,
  "syllable_count": 2287,
  "word_count": 1528,
  "sentence_count": 90,
  "paragraph_count": 77,
  "complex_word_count": 202,
  "long_word_count": 275,
  "pov_word_count": 113,
  "first_person_word_count": 8,
  "second_person_word_count": 74,
  "third_person_word_count": 31,
  "pov": "first",
  "readability_scores": {
    "automated_readability_index": 0.281,
    "coleman_liau_index": 9.425,
    "flesch_kincaid_grade_level": 8.693,
    "flesch_reading_ease": 62.979,
    "gunning_fog_index": 12.079,
    "linsear_write": 10.733,
    "lix": 34.975,
    "rix": 3.056,
    "smog": 11.688
  }
}

Fixed

• prose.paragrah_count -> prose.paragraph_count

v1.1.0

Added

Basic statistics on phones to Word, Sentence, Paragraph, and Prose classes:

• x.phone_count: total number of phones in the text
• x.phone_frequency: a map of phones an the number of times each appears in the text

Also added to Word:

• word.phones: the word's phones with syllable marks as appearing in CMUdict
• word.normalized_phones: the word's phones with syllable marks removed