Checks grammar using LanguageTool.
Project description
# language_tool_python
Python wrapper for LanguageTool.
This is a fork of https://github.com/myint/language_tool_python/ (which 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_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) 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_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
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_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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for language_tool_python-1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 066584757bdd5092406ad60a113e5055f1d39e0f35d84b701475e0bdbe12f246 |
|
MD5 | ee00247399b10cad2806a3f08fe70d35 |
|
BLAKE2b-256 | cc65a2bf15bd8a9870f05f2548b5b99d1bd90702854b68636662902326fae764 |