/unanimous

pyspelling filter that removes common non-words e.g. PyPi, GitHub etc. to make CI integration easier.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Unanimous - A pyspelling plugin for common non-words

Azure Status Travis Status Appveyor Status PyPI version Python Versions PyPI downloads per month Documentation Status Coverage Status Black

Extension to make running pyspelling in CI easier. Maintains a common word exception list of technical terms so that every project does not need to exclude words like PyPi and GitHub etc..

More details can be found in the Online Documentation.

Installation

You can install unanimous for Python via pip from PyPI.

$ pip install unanimous

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:

  • pyspelling
  • dataset
  • requests
  • click
  • defusedxml

Download from PyPI.org

https://pypi.org/project/unanimous/

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 unanimous commitment to ensuring all contributions receive appropriate recognition.

License

Distributed under the terms of the GPLv3 license, "unanimous" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Additional Documentation: