Skip to main content

Checks grammar using LanguageTool.

Project description

Python wrapper for LanguageTool.

Build status

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

language-check-0.7.4.tar.gz (32.3 kB view details)

Uploaded Source

File details

Details for the file language-check-0.7.4.tar.gz.

File metadata

File hashes

Hashes for language-check-0.7.4.tar.gz
Algorithm Hash digest
SHA256 ecb323220ec76a39e5d018d134ca75ac007a04b8626640f8e709f776187c59b0
MD5 30f8bcfcd6d51efb826119ab6b578dd0
BLAKE2b-256 68f42e0e90d59ac7f84af47021173e98b4a6efece63642570fff913c66ce2a83

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page