Flake8 Plugin that spellchecks variables, functions, classes and other bits of your python code.
You can whitelist words that are specific to your project simply by adding them to whitelist.txt in the root of your project directory. Each word you add should be separated by a newline.
Spelling is assumed to be in en_US.
This plugin supports python 3.8+
Codes
SC100 - Spelling error in comments
SC200 - Spelling error in name (e.g. variable, function, class)
Enable Django support
You can enable support for a Django dictionary by adding the following to your flake8 configuration (e.g. your .flake8 file):
[flake8]
dictionaries=en_US,python,technical,djangoEnable pandas support
You can enable support for pandas DataFrames by adding the following to your flake8 configuration (e.g. your .flake8 file):
[flake8]
dictionaries=en_US,python,technical,pandasSpecify Targets
Both comments and names (variable names, function names…) are spellchecked by default. You can specify what targets to spellcheck in your flake8 configuration (e.g. in your .flake8 file):
[flake8]
spellcheck-targets=commentsThe above configuration would only spellcheck comments
[flake8]
spellcheck-targets=namesThe above configuration would only spellcheck names
Contributing
If you have found word(s) which are listed as a spelling error but are actually correct terms used in python or in technical implementations (e.g. http), then you can very easily contribute by adding those word(s) to the appropriate dictionaries:
Before you submit a PR, it is recommended to run check-sorting.sh in the root of this repository, to verify that all the dictionary files are still sorted correctly. Sorting is enforced by CI, so you’ll need to make sure the files are sorted before your PR can be merged.
Developing
Install poetry
Run poetry install
Install pre-commit and run pre-commit install --install-hooks
1 maintainer
Release files for flake8-spellcheck 0.28.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| flake8-spellcheck-0.28.0.tar.gz | 334.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| flake8_spellcheck-0.28.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 667.9 kB
Release files / flake8-spellcheck-0.28.0.tar.gz
| Download URL | flake8-spellcheck-0.28.0.tar.gz |
|---|---|
| Size | 334.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6fb79724f27097af0b4c678c7eaf731f0d87cf4c1eae7fbd7836c1c78d67e12c
|
|
BLAKE2b-256 checksum How to use checksums |
1861a5258e373ba98f2fa01f968881167cb9e92760d44b9c4fd2f8418445799b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.13 CPython/3.10.3 Linux/5.13.0-1017-aws
|
Release files / flake8_spellcheck-0.28.0-py3-none-any.whl
| Download URL | flake8_spellcheck-0.28.0-py3-none-any.whl |
|---|---|
| Size | 333.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a0a37164b9175819b143ce0f0a8d2475457af3f0d77cd8423b0daf204662ee72
|
|
BLAKE2b-256 checksum How to use checksums |
1c0617debcfce46c197e5158177aa2b076bc4fdf2f189d64272dc553b33018b5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.13 CPython/3.10.3 Linux/5.13.0-1017-aws
|
