language-check

Python wrapper for LanguageTool.

This is a fork of https://bitbucket.org/spirit/language_tool that produces more easily parsable results from the command-line.

Example usage

From the interpreter:

>>> import language_check
>>> tool = language_check.LanguageTool('en-US')
>>> text = u'A sentence with a error in the Hitchhiker’s Guide tot he Galaxy'
>>> matches = 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
...

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:

$ echo 'This are bad.' > example.txt

$ language-check example.txt
example.txt:1:1: THIS_NNS[3]: Did you mean 'these'?

Installation

To install via pip:

$ pip install --upgrade language-check

If you are using Python 2, you’ll need to install 3to2 beforehand:

$ pip install --upgrade 3to2

Prerequisites

Python 3.3+ (or 2.7)
lib3to2 (if installing for Python 2)
LanguageTool (Java 6.0+)

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.

Vim plugin

To use language-check in Vim, install Syntastic and use the following settings:

let g:syntastic_text_checkers = ['language_check']
let g:syntastic_text_language_check_args = '--language=en-US'

Customize your language as appropriate.

Metadata

Release files for language-check 1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for language-check 1.1
File	Size	Uploaded	Provenance
language-check-1.1.tar.gz	33.4 kB	Oct 21, 2017	Without provenance	Details

Release files / language-check-1.1.tar.gz

Download URL	language-check-1.1.tar.gz
Size	33.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`9b140fa9f0be4903ffc91e2342e77ef35596de837ebde25ac6dc066f54417fab`
BLAKE2b-256 checksum How to use checksums	`97450fd1d3683d6129f30fa09143fa383cdf6dff8bc0d1648f2cf156109cb772`
Upload date	Oct 21, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No

Security for language-check 1.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.