Formal Writing Checker
Project description
Formal Writing Checker
A script for raising some warnings to you when writing formal documents.
Warnings are raised for:
- sentence length: 30 words (can be changed)
- passive voice
- rare terms? NOT IMPLEMENTED
Installation
You can install this package from:
- PyPI:
pip install formal-writing-checker
- GitHub:
pip install git+https://github.com/MartinoMensio/formal-writing-checker.git
Usage
Once installed, the script is available as
formal-writing-checker "Let's say I am told to check this sentence. Why am I using the passive voice anyways?"
# Or use a text file as input
cat > example_long_text.txt <<EOF
On offering to help the blind man, the man who then stole his car, had not, at that precise moment, had any evil intention, quite the contrary, what he did was nothing more than obey those feelings of generosity and altruism which, as everyone knows, are the two best traits of human nature and to be found in much more hardened criminals than this one, a simple car-thief without any hope of advancing in his profession, exploited by the real owners of this enterprise, for it is they who take advantage of the needs of the poor.
EOF
formal-writing-checker "$(cat example_long_text.txt)"
Options
The behaviour can be customised with the following options (can be seen with formal-writing-checker --help
):
-m, --max-sentence-length INTEGER
Maximum sentence length [default: 30]
-s, --use-statistical-sentencizer
Use statistical sentencizer instead
of rule-based sentencizer [default: False]
-l, --ignore-sentence-length Disable passive voice check [default:
False]
-p, --ignore-passive-voice Disable passive voice check [default:
False]
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
Close
Hashes for formal_writing_checker-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cf8f6b9fe851129bfb4037732a5d1de037939acddfc87406654a8abb91deeac |
|
MD5 | 66bf4dc2f99d426beb6acb250d823497 |
|
BLAKE2b-256 | e2a7bf0d665629da183253f5677eb563d4a5195432cd3d8d5568639f2ba62f8d |