language-check 0.5.2

Example usage

From the interpreter:

>>> import language_check
>>> lang_check = language_check.LanguageTool("en-US")
>>> text = "A sentence with a error in the Hitchhiker’s Guide tot he Galaxy"
>>> matches = lang_check.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_check.correct(text, matches)
'A sentence with an error in the Hitchhiker’s Guide to the Galaxy'

From the command line:

$ language-check example.txt
foo.txt:1:17: Use 'an' instead of 'a' if the following word starts with a
    vowel sound, e.g. 'an article', 'an hour'; suggestions: an
foo.txt:1:51: Did you mean 'to the'?; suggestions: to the

Installation

To install via pip:

$ pip install --user --upgrade language-check

Prerequisites

• Python 3.2+ (or 2.7)

• LanguageTool

• lib3to2 (if installing for Python 2)

The installation process should take care of downloading LanguageTool (it may take a few minutes). Otherwise, you can manually download LanguageTool-stable.zip and unzip it into where the language_check package resides.

LanguageTool requires Java 6 or later.