Metadata-Version: 2.4
Name: lingotweaker
Version: 0.2.0
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Text Processing :: Linguistic
Summary: Proofreading engine for many languages: Rust core with Python bindings
Keywords: proofreading,grammar,spellcheck,nlp,language
License: LGPL-2.1-or-later
Requires-Python: >=3.9
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Changelog, https://github.com/fiduswriter/LingoTweaker/releases
Project-URL: Homepage, https://fiduswriter.github.io/LingoTweaker/
Project-URL: Repository, https://github.com/fiduswriter/LingoTweaker

# LingoTweaker (Python)

Python bindings for the LingoTweaker proofreading engine (Rust core, PyO3).
The extension module is imported as `lt_py`; the distribution is named
`lingotweaker`.

```python
import lt_py

engine = lt_py.Engine("en-US")
for match in engine.check("I can heard you."):
    print(match["rule_id"], match["suggestions"])
```

This wheel ships **code only**. Language data is installed separately, one PyPI
distribution per language:

```sh
pip install lingotweaker lingotweaker-data-en
```

`lt_py` then finds the data automatically for a matching language:

```python
import lt_py

engine = lt_py.Engine("en-US")
```

Each `lingotweaker-data-<lang>` package exposes its directory as
`lingotweaker_data_<lang>.data_dir()` if you prefer to pass it explicitly
(`lt_py.Engine(..., data_dir=data_dir())`) or to set `LT_DATA_DIR` (which also
accepts a single `.pack`/`.pack.gz` file). Per-language packs and archives are
attached to each [GitHub Release](https://github.com/fiduswriter/LingoTweaker/releases)
as well. See the repository README and `data/README.md` for how the data tree is
produced.

LingoTweaker is an independent project and includes a port of the legacy
LanguageTool proofreading engine and its rule data. Upstream references and
licenses are kept; see `THIRD_PARTY_NOTICES.md` in the repository.

License: LGPL-2.1-or-later.
