prosegrinder / python-prosegrinder Goto Github PK

• prospector
• bandit

A bookwormpackage already exists and is still active. Rename this package, possibly just to prosegrinder.

https://opensource.guide/code-of-conduct/
https://www.contributor-covenant.org/

Provide better documentation.

Adding a feature to prosegrinder to enable the detection of English phonemes might be really useful.

There are over 40 phonemes in English despite only 26 letters in its alphabet - here's one source: https://www.dyslexia-reading-well.com/44-phonemes-in-english.html.

I don't know how this would work, perhaps implemented as a new 'get_phoneme' method to the Dictionary class in the dictionary.py module. It would be nice if the feature could not only count the total number of phonemes but also output an iterable containing the specific phonemes that occur in a section of text/prose.

https://help.github.com/articles/setting-guidelines-for-repository-contributors/

It would be great to have the Linsear Write Formula added to the ReadabilityScores class.
https://en.wikipedia.org/wiki/Linsear_Write

Using the @property annotation has complicated code both here and in trying to create a REST API wrapper. Using the annotation doesn't seem to be providing any benefit at this point.

• remove the @property annotations
• remove the _ before the properties and use them directly

I would like to use prosegrinder in a version control system for managing prose, perhaps in a git hook or a GitHub Action so that it runs automatically on each new commit. To make this happen, perhaps prosegrinder needs some command line usage support or some other top level module that can be executable from the command line.

• convert README to markdown
• bring packaging to current practices
  • create pyproject.toml
  • move settings to setup.cfg
• retire Codacy in favor of GitHub Actions (pylint, black)
  • add lint job to CI workflow
• use pypi-publish
  • create test publish workflow on tags
  • update publish on release reworkflow
• add twine check job to CI workflow

CLI should be able to process multiple files at once. Output should probably be on a file-by-file basis and not a summary. Maybe both.