Metadata-Version: 2.4
Name: language_tool
Version: 0.4
Summary: LanguageTool through server mode
Author-email: spirit <hiddenspirit@gmail.com>
Project-URL: Homepage, https://github.com/hiddenspirit/language_tool
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: COPYING
License-File: COPYING.LESSER
Requires-Dist: packaging
Dynamic: license-file

language_tool – LanguageTool through server mode
================================================


Example usage
-------------

>>> import language_tool
>>> lang_tool = language_tool.LanguageTool("en-US")
>>> text = "A sentence with a error in the Hitchhiker’s Guide tot he Galaxy"
>>> matches = lang_tool.check(text)
>>> len(matches)
2


Check out some ``Match`` object attributes:

>>> matches[0].fromy, matches[0].fromx
(0, 16)
>>> matches[0].ruleId, matches[0].replacements
('EN_A_VS_AN', ['an'])
>>> matches[1].fromy, matches[1].fromx
(0, 50)
>>> matches[1].ruleId, matches[1].replacements
('TOT_HE', ['to the'])


Print a ``Match`` object:

>>> print(matches[1])
Line 1, column 51, Rule ID: TOT_HE[1]
Message: Did you mean 'to the'?
Suggestion: to the
... with a error in the Hitchhiker’s Guide tot he Galaxy
                                           ^^^^^^


Automatically apply suggestions to the text:

>>> language_tool.correct(text, matches)
'A sentence with an error in the Hitchhiker’s Guide to the Galaxy'


Installation
------------

To install the package, use::

  $ pip install language_tool

Or using uv::

  $ uv pip install language_tool


Prerequisites
-------------

- `Python 3.8+ <https://www.python.org>`_
- `LanguageTool <https://languagetool.org>`_


The installation process should take care of downloading LanguageTool
(it may take a few minutes).
Otherwise, you can manually download `LanguageTool-stable.zip
<https://languagetool.org/download/LanguageTool-stable.zip>`_
and unzip it into where the ``language_tool`` package resides.

LanguageTool requires Java 8 or later.
