Skip to main content

Checks grammar using LanguageTool.

Project description

# language_tool_python

Python wrapper for LanguageTool.

Build status

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

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


Download files

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

Source Distribution

language_tool_python-2.0.1.tar.gz (32.9 kB view details)

Uploaded Source

Built Distribution

language_tool_python-2.0.1-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

Details for the file language_tool_python-2.0.1.tar.gz.

File metadata

  • Download URL: language_tool_python-2.0.1.tar.gz
  • Upload date:
  • Size: 32.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.0.0.post20200309 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for language_tool_python-2.0.1.tar.gz
Algorithm Hash digest
SHA256 8fbc76759c3245b88dc92d108dcdd9ee8d45b6b55303324c16893d8fc2d2bab1
MD5 3215f96a4a248eb8c5113b7c17cea68c
BLAKE2b-256 eb9d33178f25f9321ab34bee834030563628278cbfc31c12e4fb38d41c551dc4

See more details on using hashes here.

File details

Details for the file language_tool_python-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: language_tool_python-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 28.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.0.0.post20200309 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for language_tool_python-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 81c6ae09db84d10c3a74ac4da6149d52283be3b7393b54506fe3dd9e5396fae4
MD5 9cd227dc45c43cb576f6fd1d8d072928
BLAKE2b-256 34fdd26a05d9b96437ed6028746b90638f4cc7e282c6bc1fa2fe3dc637214456

See more details on using hashes here.

Supported by

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