Skip to main content

Spell checker.

Project description

Donate via PayPal Discord Build Coverage Status PyPI Version PyPI - Python Version License

PySpelling

Overview

PySpelling is a module to help with automating spell checking in a project with Aspell or Hunspell. It is essentially a wrapper around the command line utility of these two spell checking tools, and allows you to setup different spelling tasks for different file types. You can apply specific and different filters and options to each task. PySpelling can also be used in CI environments to fail the build if there are misspelled words.

Aspell and Hunspell are very good spell checking tools. Aspell particularly comes with a couple of filters, but the filters are limited in types and aren't extremely flexible. PySpelling was created to work around Aspell's and Hunspell's filtering shortcomings by creating a wrapper around them that could be extended to handle more kinds of file formats and provide more advanced filtering. If you need to filter out specific HTML tags with specific IDs or class names, PySpelling can do it. If you want to scan Python files for docstrings, but also avoid specific content within the docstring, you can do that as well. If PySpelling doesn't have a filter you need, with access to so many available Python modules, you can easily write your own.

Documentation

Extension documentation is found here: https://facelessuser.github.io/pyspelling/.

License

MIT

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

pyspelling-2.9.tar.gz (147.4 kB view details)

Uploaded Source

Built Distribution

pyspelling-2.9-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

Details for the file pyspelling-2.9.tar.gz.

File metadata

  • Download URL: pyspelling-2.9.tar.gz
  • Upload date:
  • Size: 147.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for pyspelling-2.9.tar.gz
Algorithm Hash digest
SHA256 df74c42e6e24171b7e1a83ac62fa2e151028ac045817c4f0384791c2d6099c5c
MD5 068b17bf30c56db7c8e02f6f943a9e3b
BLAKE2b-256 cc49789313a50b9cf1f46389f38d90549269472093ea4f21aff9269c5ff0a41c

See more details on using hashes here.

Provenance

File details

Details for the file pyspelling-2.9-py3-none-any.whl.

File metadata

  • Download URL: pyspelling-2.9-py3-none-any.whl
  • Upload date:
  • Size: 44.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for pyspelling-2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 43d781339ee17fec408b63bc25e1684fa025ce2edfc9e42742b66f10f6bd1450
MD5 a5704763cbacc3cb34ec3623672b260b
BLAKE2b-256 22c94a53b2fc18c4b88bfa5e310c0e21fd3916b9a260fbdd26ca7b70f88d79dd

See more details on using hashes here.

Provenance

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