CI configuration engine for pyspelling using plugins like resplendent and unanimous to make CI integration easier.
Project description
Spelling - spell checker for CI
CI configuration engine for pyspelling using plugins like resplendent and unanimous to make CI integration easier.
More details can be found in the Online Documentation.
Exemptions
If the spelling checker reports a spelling mistake which is actually a deliberate choice an exemption can be made in a few ways:
- Words containing uppercase characters are assumed to be proper nouns and ignored.
- Escaping can be achieved through the use of back ticks ` around the word.
- Adding to a custom wordlist wordlist.txt or spelling_wordlist.txt found in any sub-directory.
- Adding to the global wordlist https://github.com/resplendent-dev/unanimous
Installation
You can install spelling for Python via pip from PyPI.
$ pip install spelling
Note: if using Python 3.4 the latest version of lxml only supports python 3.5 and above so install lxml 4.3.4
Prerequisites:
- dataset
- pyspelling
- wcmatch
- resplendent
- unanimous>=0.8.2
- PyYAML
Download from PyPI.org
https://pypi.org/project/spelling/
Contributing
Contributions are very welcome, consider using the file an issue to discuss the work before beginning, but if you already have a Pull Request ready then this is no problem, please submit it and it will be very gratefully considered. The Contribution Guidelines outlines the spelling commitment to ensuring all contributions receive appropriate recognition.
License
Distributed under the terms of the GPLv3 license, "spelling" is free and open source software
Issues
If you encounter any problems, please file an issue along with a detailed description.
Additional Documentation:
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.
