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.13.0.tar.gz (332.4 kB view details)

Uploaded Source

Built Distribution

flake8_spellcheck-0.13.0-py2.py3-none-any.whl (331.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: flake8-spellcheck-0.13.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.43.0 CPython/3.8.2

File hashes

Hashes for flake8-spellcheck-0.13.0.tar.gz
Algorithm Hash digest
SHA256 3ebd8b79065d4b596a1db6cbf253ebac815c519b2b7dd6b1bf1c6c166a404f69
MD5 c159793b210b4947d5ed567e45e37165
BLAKE2b-256 817682e5125f40a151faac3518b16a8ac94a072288b1d15a33a8315576524de9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flake8_spellcheck-0.13.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 331.3 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.43.0 CPython/3.8.2

File hashes

Hashes for flake8_spellcheck-0.13.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e6dbd944c607c917fff15b5e293a61d7d290570bd9cd714b6f4180cc12a7dc5f
MD5 f15484a232676a46759b4fb85e54a9d4
BLAKE2b-256 dd651edee51cbbf30f36e803e030b896c320e7bbef95a93b3408963f80fd6ceb

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