| Name | pyspelling JSON |
| Version |
2.10
JSON |
| download |
| home_page | |
| Summary | Spell checker. |
| upload_time | 2024-01-13 06:08:26 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
spelling
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
[![Donate via PayPal][donate-image]][donate-link]
[![Build][github-ci-image]][github-ci-link]
[![Coverage Status][codecov-image]][codecov-link]
[![PyPI Version][pypi-image]][pypi-link]
[![PyPI - Python Version][python-image]][pypi-link]
![License][license-image-mit]
# PySpelling
## Overview
PySpelling is a module to help with automating spell checking in a project with [Aspell][aspell] or
[Hunspell][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
[aspell]: http://aspell.net/
[hunspell]: https://hunspell.github.io/
[github-ci-image]: https://github.com/facelessuser/pyspelling/workflows/build/badge.svg?branch=master&event=push
[github-ci-link]: https://github.com/facelessuser/pyspelling/actions?query=workflow%3Abuild+branch%3Amaster
[codecov-image]: https://img.shields.io/codecov/c/github/facelessuser/pyspelling/master.svg?logo=codecov&logoColor=aaaaaa&labelColor=333333
[codecov-link]: https://codecov.io/github/facelessuser/pyspelling
[pypi-image]: https://img.shields.io/pypi/v/pyspelling.svg?logo=pypi&logoColor=aaaaaa&labelColor=333333
[pypi-link]: https://pypi.python.org/pypi/pyspelling
[python-image]: https://img.shields.io/pypi/pyversions/pyspelling?logo=python&logoColor=aaaaaa&labelColor=333333
[license-image-mit]: https://img.shields.io/badge/license-MIT-blue.svg?labelColor=333333
[donate-image]: https://img.shields.io/badge/Donate-PayPal-3fabd1?logo=paypal
[donate-link]: https://www.paypal.me/facelessuser
Raw data
{
"_id": null,
"home_page": "",
"name": "pyspelling",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "spelling",
"author": "",
"author_email": "Isaac Muse <Isaac.Muse@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/12/07/168a857755a29b7e41550a28cd8f527025bc62fcb36a951d8f3f2eedcdf7/pyspelling-2.10.tar.gz",
"platform": null,
"description": "[![Donate via PayPal][donate-image]][donate-link]\n[![Build][github-ci-image]][github-ci-link]\n[![Coverage Status][codecov-image]][codecov-link]\n[![PyPI Version][pypi-image]][pypi-link]\n[![PyPI - Python Version][python-image]][pypi-link]\n![License][license-image-mit]\n# PySpelling\n\n## Overview\n\nPySpelling is a module to help with automating spell checking in a project with [Aspell][aspell] or\n[Hunspell][hunspell]. It is essentially a wrapper around the command line utility of these two spell checking tools, and\nallows you to setup different spelling tasks for different file types. You can apply specific and different filters and\noptions to each task. PySpelling can also be used in CI environments to fail the build if there are misspelled words.\n\nAspell and Hunspell are very good spell checking tools. Aspell particularly comes with a couple of filters, but the\nfilters are limited in types and aren't extremely flexible. PySpelling was created to work around Aspell's and\nHunspell's filtering shortcomings by creating a wrapper around them that could be extended to handle more kinds of file\nformats and provide more advanced filtering. If you need to filter out specific HTML tags with specific IDs or class\nnames, PySpelling can do it. If you want to scan Python files for docstrings, but also avoid specific content within the\ndocstring, you can do that as well. If PySpelling doesn't have a filter you need, with access to so many available\nPython modules, you can easily write your own.\n\n## Documentation\n\nExtension documentation is found here: https://facelessuser.github.io/pyspelling/.\n\n## License\n\nMIT\n\n[aspell]: http://aspell.net/\n[hunspell]: https://hunspell.github.io/\n\n[github-ci-image]: https://github.com/facelessuser/pyspelling/workflows/build/badge.svg?branch=master&event=push\n[github-ci-link]: https://github.com/facelessuser/pyspelling/actions?query=workflow%3Abuild+branch%3Amaster\n[codecov-image]: https://img.shields.io/codecov/c/github/facelessuser/pyspelling/master.svg?logo=codecov&logoColor=aaaaaa&labelColor=333333\n[codecov-link]: https://codecov.io/github/facelessuser/pyspelling\n[pypi-image]: https://img.shields.io/pypi/v/pyspelling.svg?logo=pypi&logoColor=aaaaaa&labelColor=333333\n[pypi-link]: https://pypi.python.org/pypi/pyspelling\n[python-image]: https://img.shields.io/pypi/pyversions/pyspelling?logo=python&logoColor=aaaaaa&labelColor=333333\n[license-image-mit]: https://img.shields.io/badge/license-MIT-blue.svg?labelColor=333333\n[donate-image]: https://img.shields.io/badge/Donate-PayPal-3fabd1?logo=paypal\n[donate-link]: https://www.paypal.me/facelessuser\n",
"bugtrack_url": null,
"license": "",
"summary": "Spell checker.",
"version": "2.10",
"project_urls": {
"Homepage": "https://github.com/facelessuser/pyspelling"
},
"split_keywords": [
"spelling"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f16242558b5c5cb73efd52490f1e6bfb03eae63b2585770b9cae78bd491ef0b",
"md5": "6650b90fadc4ceec9c481ee2cac32a22",
"sha256": "9b079dd238bd0616a49f9ac5df32799beb851dddc5ed7634f551e7df1aeee943"
},
"downloads": -1,
"filename": "pyspelling-2.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6650b90fadc4ceec9c481ee2cac32a22",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 45035,
"upload_time": "2024-01-13T06:08:23",
"upload_time_iso_8601": "2024-01-13T06:08:23.641288Z",
"url": "https://files.pythonhosted.org/packages/9f/16/242558b5c5cb73efd52490f1e6bfb03eae63b2585770b9cae78bd491ef0b/pyspelling-2.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1207168a857755a29b7e41550a28cd8f527025bc62fcb36a951d8f3f2eedcdf7",
"md5": "34214d71aef6411ebcf30e3686d28f0d",
"sha256": "acd67133c1b7cecd410e3d4489e61f2e4b1f0b6acf1ae6c48c240fbb21729c37"
},
"downloads": -1,
"filename": "pyspelling-2.10.tar.gz",
"has_sig": false,
"md5_digest": "34214d71aef6411ebcf30e3686d28f0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 148239,
"upload_time": "2024-01-13T06:08:26",
"upload_time_iso_8601": "2024-01-13T06:08:26.100984Z",
"url": "https://files.pythonhosted.org/packages/12/07/168a857755a29b7e41550a28cd8f527025bc62fcb36a951d8f3f2eedcdf7/pyspelling-2.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-13 06:08:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "facelessuser",
"github_project": "pyspelling",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pyspelling"
}
