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.

Source Distribution

flake8-spellcheck-0.14.0.tar.gz (332.4 kB view details)

Uploaded Source

Built Distribution

flake8_spellcheck-0.14.0-py2.py3-none-any.whl (655.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file flake8-spellcheck-0.14.0.tar.gz.

File metadata

  • Download URL: flake8-spellcheck-0.14.0.tar.gz
  • Upload date:
  • Size: 332.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.3

File hashes

Hashes for flake8-spellcheck-0.14.0.tar.gz
Algorithm Hash digest
SHA256 908b4e5c6200cbd38886aa4f9c7481bf4533f9a416a3d9363e503b8e6a54f004
MD5 586f8724672ad53c8979cd12502f4aad
BLAKE2b-256 e87ad97be41335f19ba1639dc452b7c0026c5bc37dc5541404532d635ff965eb

See more details on using hashes here.

File details

Details for the file flake8_spellcheck-0.14.0-py2.py3-none-any.whl.

File metadata

  • Download URL: flake8_spellcheck-0.14.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 655.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.3

File hashes

Hashes for flake8_spellcheck-0.14.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 46e2cbc2cb66d6fe2c1ad1ec1cdbdc129e304ecb50893a49330c99b838395df6
MD5 d51c0bdcb429285c97d96f195f977a0b
BLAKE2b-256 6abecee843fb2243ee25d963e3b03be3ae473f9a5659be6fcccb7611eca1d864

See more details on using hashes here.

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