# Python text speller
[](https://github.com/oriontvv/pyaspeller/actions) [](https://coveralls.io/r/oriontvv/pyaspeller) [](https://pypi.org/project/pyaspeller)
[pyaspeller](https://github.com/oriontvv/pyaspeller) (Python Yandex Speller) is a cli tool and pure python library for searching typos in texts, files and websites.
Spell checking uses [Yandex.Speller API](https://tech.yandex.ru/speller/doc/dg/concepts/About-docpage/). ([restrictions](<https://yandex.ru/legal/speller_api/>))
## Features
* Command line tool
You can correct your local files or web pages
```bash
$ pyaspeller ./doc
$ pyaspeller https://team-tricky.github.io
$ pyaspeller "в суббботу утромъ"
в субботу утром
```
* Library
Use speller for your code
```python
>>> from pyaspeller import YandexSpeller
>>> speller = YandexSpeller()
>>> fixed = speller.spelled('Triky Custle is a great puzzle game.')
>>> fixed
'Tricky Castle is a great puzzle game.'
```
You can use class `Word` for single word queries:
```python
>>> from pyaspeller import Word
>>> check = Word('tesst')
>>> check.correct
False
>>> check.variants
[u'test']
>>> check.spellsafe
u'test'
```
## Installation
Use your favourite package manager:
```bash
$ python3 -m pip install pyaspeller
```
Also, there are available [rust](https://github.com/oriontvv/ryaspeller/) and [javascript](https://github.com/hcodes/yaspeller) versions of this speller.
Raw data
{
"_id": null,
"home_page": "https://github.com/oriontvv/pyaspeller",
"name": "pyaspeller",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "spell,spelling,spellcheck,api,yandex,text",
"author": "Vasiliy Taranov",
"author_email": "taranov.vv@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/98/74/89fc58fbd0d18685e3efa009c82e21f03ee20c9bc5bfe29c7c783a213418/pyaspeller-2.0.0.tar.gz",
"platform": null,
"description": "# Python text speller\n\n[](https://github.com/oriontvv/pyaspeller/actions) [](https://coveralls.io/r/oriontvv/pyaspeller) [](https://pypi.org/project/pyaspeller)\n\n\n[pyaspeller](https://github.com/oriontvv/pyaspeller) (Python Yandex Speller) is a cli tool and pure python library for searching typos in texts, files and websites.\n\nSpell checking uses [Yandex.Speller API](https://tech.yandex.ru/speller/doc/dg/concepts/About-docpage/). ([restrictions](<https://yandex.ru/legal/speller_api/>))\n\n\n## Features\n\n* Command line tool\n\nYou can correct your local files or web pages\n\n```bash \n$ pyaspeller ./doc\n$ pyaspeller https://team-tricky.github.io\n$ pyaspeller \"\u0432 \u0441\u0443\u0431\u0431\u0431\u043e\u0442\u0443 \u0443\u0442\u0440\u043e\u043c\u044a\"\n\u0432 \u0441\u0443\u0431\u0431\u043e\u0442\u0443 \u0443\u0442\u0440\u043e\u043c\n```\n\n* Library \n\nUse speller for your code\n\n```python\n>>> from pyaspeller import YandexSpeller\n>>> speller = YandexSpeller()\n>>> fixed = speller.spelled('Triky Custle is a great puzzle game.')\n>>> fixed\n'Tricky Castle is a great puzzle game.'\n```\n\nYou can use class `Word` for single word queries:\n\n```python\n>>> from pyaspeller import Word\n>>> check = Word('tesst')\n>>> check.correct\nFalse\n>>> check.variants\n[u'test']\n>>> check.spellsafe\nu'test'\n```\n\n\n## Installation\n\nUse your favourite package manager:\n\n```bash\n$ python3 -m pip install pyaspeller\n```\n\nAlso, there are available [rust](https://github.com/oriontvv/ryaspeller/) and [javascript](https://github.com/hcodes/yaspeller) versions of this speller.\n",
"bugtrack_url": null,
"license": "Apache 2",
"summary": "Search tool typos in the text, files and websites.",
"version": "2.0.0",
"project_urls": {
"Documentation": "https://github.com/oriontvv/pyaspeller",
"Homepage": "https://github.com/oriontvv/pyaspeller",
"Repository": "https://github.com/oriontvv/pyaspeller"
},
"split_keywords": [
"spell",
"spelling",
"spellcheck",
"api",
"yandex",
"text"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b5a30ac754d8a08bbe7560ee6a932267c4961285036a0a92256886c01863b1e",
"md5": "026b980a62f7d5debd00774603733923",
"sha256": "2ecb94b0bd06992b6ae8d9754e21e0cf4fbbe1730121a2eb5ad449d6d31fbf75"
},
"downloads": -1,
"filename": "pyaspeller-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "026b980a62f7d5debd00774603733923",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 12114,
"upload_time": "2023-11-19T19:45:02",
"upload_time_iso_8601": "2023-11-19T19:45:02.189251Z",
"url": "https://files.pythonhosted.org/packages/9b/5a/30ac754d8a08bbe7560ee6a932267c4961285036a0a92256886c01863b1e/pyaspeller-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "987489fc58fbd0d18685e3efa009c82e21f03ee20c9bc5bfe29c7c783a213418",
"md5": "1b27682f2e103feba2211a5346021099",
"sha256": "41e4291ef68dfc4da9b6f1eab42deb699956a3a73c8c35f4ff5d55c104d18d42"
},
"downloads": -1,
"filename": "pyaspeller-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "1b27682f2e103feba2211a5346021099",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 11085,
"upload_time": "2023-11-19T19:45:03",
"upload_time_iso_8601": "2023-11-19T19:45:03.744028Z",
"url": "https://files.pythonhosted.org/packages/98/74/89fc58fbd0d18685e3efa009c82e21f03ee20c9bc5bfe29c7c783a213418/pyaspeller-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-19 19:45:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oriontvv",
"github_project": "pyaspeller",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyaspeller"
}
JSON
