Skip to main content

Checks grammar using LanguageTool.

Project description

# language_tool_python

Python wrapper for LanguageTool.

Build status

This is a fork of (which is a fork of that produces more easily parsable results from the command-line.

## Example usage

From the interpreter:

>>> import language_tool_python
>>> tool = language_tool_python.LanguageTool('en-US')
>>> text = u'A sentence with a error in the Hitchhiker’s Guide tot he Galaxy'
>>> matches = tool.check(text)
>>> len(matches)

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_tool_python.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_tool_python example.txt
example.txt:1:1: THIS_NNS[3]: Did you mean 'these'?

## Installation

To install via pip:

$ pip install --upgrade language_tool_python

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

$ pip install --upgrade 3to2

To overwrite the host part of URL that is used to download LanguageTool-{version}.zip:

- SET language_tool_python_DOWNLOAD_HOST = [alternate URL]

## Prerequisites

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

## Vim plugin

To use language_tool_python in Vim, install Syntastic and use the following settings:

let g:syntastic_text_checkers = ['language_tool_python']
let g:syntastic_text_language_tool_python_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.

Files for language-tool-python, version 1.1
Filename, size File type Python version Upload date Hashes
Filename, size language_tool_python-1.1-py3-none-any.whl (25.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size language_tool_python-1.1.tar.gz (32.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page