1- language-check
2- ==============
1+ # language_tool_python
32
43Python wrapper for LanguageTool.
54
6- .. image :: https://travis-ci.org/myint/language-check .svg?branch=master
7- :target: https://travis-ci.org/myint/language-check
5+ .. image:: https://travis-ci.org/myint/language_tool_python .svg?branch=master
6+ :target: https://travis-ci.org/myint/language_tool_python
87 :alt: Build status
98
10- This is a fork of https://github.com/myint/language-check / (which is a fork of
9+ This is a fork of https://github.com/myint/language_tool_python / (which is a fork of
1110https://bitbucket.org/spirit/language_tool ) that produces more easily parsable
1211results from the command-line.
1312
14- Example usage
15- -------------
13+ ## Example usage
1614
1715From the interpreter:
1816
19- >>> import language_check
20- >>> tool = language_check .LanguageTool(' en-US' )
17+ >>> import language_tool_python
18+ >>> tool = language_tool_python .LanguageTool('en-US')
2119 >>> text = u'A sentence with a error in the Hitchhiker’s Guide tot he Galaxy'
2220 >>> matches = tool.check(text)
2321 >>> len(matches)
@@ -44,35 +42,33 @@ Suggestion: to the
4442
4543Automatically apply suggestions to the text:
4644
47- >>> language_check .correct(text, matches)
45+ >>> language_tool_python .correct(text, matches)
4846 'A sentence with an error in the Hitchhiker’s Guide to the Galaxy'
4947
5048From the command line::
5149
5250 $ echo 'This are bad.' > example.txt
5351
54- $ language-check example.txt
52+ $ language_tool_python example.txt
5553 example.txt:1:1: THIS_NNS[3]: Did you mean 'these'?
5654
5755
58- Installation
59- ------------
56+ ## Installation
6057
6158To install via pip::
6259
63- $ pip install --upgrade language-check
60+ $ pip install --upgrade language_tool_python
6461
6562If you are using Python 2, you'll need to install 3to2 beforehand::
6663
6764 $ pip install --upgrade 3to2
6865
6966To overwrite the host part of URL that is used to download LanguageTool-{version}.zip::
7067
71- - SET LANGUAGE_CHECK_DOWNLOAD_HOST = [alternate URL]
68+ - SET language_tool_python_DOWNLOAD_HOST = [alternate URL]
7269
7370
74- Prerequisites
75- -------------
71+ ## Prerequisites
7672
7773- ` Python 3.3+ <https://www.python.org> ` _ (or 2.7)
7874- ` lib3to2 <https://bitbucket.org/amentajo/lib3to2> ` _
@@ -84,18 +80,17 @@ The installation process should take care of downloading LanguageTool (it may
8480take a few minutes). Otherwise, you can manually download
8581`LanguageTool-stable.zip
8682< https://www.languagetool.org/download/LanguageTool-stable.zip > `_ and unzip it
87- into where the ``language_check `` package resides.
83+ into where the `` language_tool_python `` package resides.
8884
89- Vim plugin
90- ----------
85+ ## Vim plugin
9186
92- To use language-check in Vim, install Syntastic _ and use the following
87+ To use language_tool_python in Vim, install Syntastic_ and use the following
9388settings:
9489
9590.. code-block:: vim
9691
97- let g:syntastic_text_checkers = ['language_check ']
98- let g:syntastic_text_language_check_args = '--language=en-US'
92+ let g:syntastic_text_checkers = ['language_tool_python ']
93+ let g:syntastic_text_language_tool_python_args = '--language=en-US'
9994
10095Customize your language as appropriate.
10196
0 commit comments