https://github.com/oriontvv/pyaspeller
Python text speller
https://github.com/oriontvv/pyaspeller
api python spell-check yandex
Last synced: 6 months ago
JSON representation
Python text speller
- Host: GitHub
- URL: https://github.com/oriontvv/pyaspeller
- Owner: oriontvv
- License: apache-2.0
- Created: 2015-08-09T21:03:20.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2025-01-02T12:38:10.000Z (over 1 year ago)
- Last Synced: 2025-09-29T04:29:43.441Z (9 months ago)
- Topics: api, python, spell-check, yandex
- Language: Python
- Size: 432 KB
- Stars: 40
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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]())
## Installation
* Highly recommend to use latest [uv](https://docs.astral.sh/uv/getting-started/installation/)
* `uv add pyaspeller` (for library mode)
## Features
* Command line tool
You can correct your local files or web pages
```bash
$ uvx pyaspeller ./doc
$ uvx pyaspeller https://team-tricky.github.io
$ uvx 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'
```
Also, there are available [rust](https://github.com/oriontvv/ryaspeller/) and [javascript](https://github.com/hcodes/yaspeller) versions of this speller.