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


  • 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):


Enable pandas support

You can enable support for pandas DataFrames by adding the following to your flake8 configuration (e.g. your .flake8 file):


Specify 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):


The above configuration would only spellcheck comments


The above configuration would only spellcheck names


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


  • Install poetry

  • Run poetry install

  • Install pre-commit and run pre-commit install --install-hooks

Project details

Download files

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

Source Distribution

flake8-spellcheck-0.28.0.tar.gz (334.4 kB view hashes)

Uploaded source

Built Distribution

flake8_spellcheck-0.28.0-py3-none-any.whl (333.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page