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:
1 maintainer
Metadata
1 maintainer
Release files for spelling 1.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| spelling-1.2.3.tar.gz | 13.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| spelling-1.2.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.4 kB
Release files / spelling-1.2.3.tar.gz
| Download URL | spelling-1.2.3.tar.gz |
|---|---|
| Size | 13.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6e3837a408004251ec589845bfa17a6a3db8a86d54b1eb8755622ea95deba442
|
|
BLAKE2b-256 checksum How to use checksums |
e697e6d6df6f1a5a4d438ac6bf422f95e4b962b1d5c20bbcef43e0fa70999361
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.13.0+
|
Release files / spelling-1.2.3-py3-none-any.whl
| Download URL | spelling-1.2.3-py3-none-any.whl |
|---|---|
| Size | 10.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6cc79f66d4f28760ba94a272f52ff3718b89da4e22ce605e358faf3945040b48
|
|
BLAKE2b-256 checksum How to use checksums |
f43a34670b97c0824bd81b7f6d6b77738aec9165055d447e1302bc16ff191b05
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.13.0+
|
Security for spelling 1.2.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
