Checks grammar using LanguageTool.
Project description
# language_tool_python: a grammar checker for Python 📝
This is a Python wrapper for [LanguageTool](languagetool.org). LanguageTool is open-source grammar tool, also known as the spellchecker for OpenOffice. This library allows you to make to detect grammar errors and spelling mistakes through a Python script or through a command-line interface.
## Local and Remote Servers
By default, language_tool_python will download a LanguageTool server .jar and run that in the background to detect grammar errors locally. However, LanguageTool also offers a [Public HTTP Proofreading API](http://wiki.languagetool.org/public-http-api) that is supported as well. Follow the link for rate limiting details. (Running locally won’t have the same restrictions.)
### Using language_tool_python locally
Local server is the default setting. To use this, just initialize a LanguageTool object:
import language_tool_python tool = language_tool_python.LanguageTool(‘en-US’) # use a local server (automatically set up), language English
### Using language_tool_python with the public LanguageTool remote server
There is also a built-in class for querying LanguageTool’s public servers. Initialize it like this:
import language_tool_python tool = language_tool_python.LanguageToolPublicAPI(‘es’) # use the public API, language Spanish
### Using language_tool_python with the another remote server
Finally, you’re able to pass in your own remote server as an argument to the LanguageTool class:
import language_tool_python tool = language_tool_python.LanguageTool(‘ca-ES’, remote_server=’https://language-tool-api.mywebsite.net’) # use a remote server API, language Catalan
## 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].ruleId, matches[0].replacements (‘EN_A_VS_AN’, [‘an’]) 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:
tool.correct(text) ‘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
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.
### LanguageTool Version
As of April 2020, language_tool_python was forked from language-check and no longer supports LanguageTool versions lower than 4.0.
### Acknowledgements This is a fork of https://github.com/myint/language-check/ (which is a fork of https://bitbucket.org/spirit/language_tool) that produces more easily parsable results from the command-line.
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-2.0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c129f65522326d989ba28ad29fc56e40c7bda886cb077c7b7a9ba8b8bf9ee3f |
|
MD5 | 1156b040af424e00356078aa081ec5ce |
|
BLAKE2b-256 | 0d4f6aafb1e2c8fe08e0bfe0691c8ca524082d5445539210874d3250154c7a42 |
Hashes for language_tool_python-2.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 166360474942ccaf03738dec7f88df255829124e373c070a72f4fa582700ed2d |
|
MD5 | e4243f1042f1bbc92c1d527e2366377c |
|
BLAKE2b-256 | 7330034d16a63c2c17f245bda1cb5e14e30670eb3ef114b276a29b35de04185d |