Skip to main content

Spellcheck variables, comments and docstrings

Project description

CircleCI Black PyPi

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.5+

Codes

  • SC100 - Spelling error in comments
  • SC200 - Spelling error in name (e.g. variable, function, class)

Contributing

If you have found word(s) which is listed as a spelling error but is actually a correct term 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:

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,django

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for flake8-spellcheck, version 0.13.0
Filename, size File type Python version Upload date Hashes
Filename, size flake8_spellcheck-0.13.0-py2.py3-none-any.whl (331.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size flake8-spellcheck-0.13.0.tar.gz (332.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page