Check text files for issues.
Project description
textcheck
Run text checks on files from the command line.
┏━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Word ┃ Alternatives ┃ Context ┃
┡━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ speling │ spieling, spelling, spewing, peeling, splinting │ should be checked for speling │
└─────────┴─────────────────────────────────────────────────┴───────────────────────────────┘
Installation
pip install --user textcheck
Hunspell dictionary files en_US.dic
and en_US.aff
need to be placed in /usr/share/hunspell
directory.
Limitations
- Only console output for now.
- Only English language is supported.
- Only Linux-based systems are supported.
CLI usage
spellcheck
Example invocation:
textcheck spellcheck ~/spellme.txt --ignore-list=/home/user/ignore_list.txt
Run spellcheck for a set of files.
Provided ignore list is a file with ignore words on new lines.
Usage:
$ textcheck spellcheck [OPTIONS] FILES...
Arguments:
FILES...
: The list of files to check
Options
ignore_list
: Path to the ignore list file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
textcheck-0.2.2.tar.gz
(3.2 kB
view hashes)
Built Distribution
Close
Hashes for textcheck-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e09d8fe306e3f0f4391d1bee6370ad92a028235e2926007190237eb4a7d79b4 |
|
MD5 | 8fa8fe292ee8a09b6555bd63d2663416 |
|
BLAKE2b-256 | 37f1bdd5bfe7c163af72c7ffef43ac867053842b0079f5efc779216ac5970ef4 |