update README, remove xml and --api flag

Author: jxmorris12

README.md

@@ -1,49 +1,41 @@
-# language_tool_python
+# `language_tool_python`: a grammar checker for Python
 
-Python wrapper for LanguageTool.
-
-.. image:: https://travis-ci.org/myint/language_tool_python.svg?branch=master
-    :target: https://travis-ci.org/myint/language_tool_python
-    :alt: 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.
+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.
 
 ## 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
+    > 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'])
+    > 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
-...
+    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'
+    language_tool_python.correct(text, matches)
+    'A sentence with an error in the Hitchhiker’s Guide to the Galaxy'
 
 From the command line::
 
@@ -59,9 +51,6 @@ 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::
 
@@ -82,16 +71,11 @@ take a few minutes). Otherwise, you can manually download
 <https://www.languagetool.org/download/LanguageTool-stable.zip>`_ and unzip it
 into where the ``language_tool_python`` package resides.
 
-## Vim plugin
+### LanguageTool Version
 
-To use language_tool_python in Vim, install Syntastic_ and use the following
-settings:
+As of April 2020, `language_tool_python` was forked from `language-check` and no longer supports LanguageTool versions lower than 4.0.
 
-.. code-block:: vim
-
-    let g:syntastic_text_checkers = ['language_tool_python']
-    let g:syntastic_text_language_tool_python_args = '--language=en-US'
-
-Customize your language as appropriate.
-
-.. _Syntastic: https://github.com/scrooloose/syntastic
+### 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.

language_tool_python/__init__.py

@@ -40,16 +40,11 @@
 from functools import total_ordering
 from weakref import WeakValueDictionary
 
-try:
-    from xml.etree import cElementTree as ElementTree
-except ImportError:
-    from xml.etree import ElementTree
-
 from .backports import subprocess
 from .which import which
 
 
-__version__ = '2.0'
+__version__ = '2.0.1'
 
 
 __all__ = ['LanguageTool', 'Error', 'get_languages', 'correct', 'get_version',
@@ -263,12 +258,6 @@ def check(self, text: str, srctext=None) -> [Match]:
         matches = response['matches']
         return [Match(match) for match in matches]
 
-    def _check_api(self, text: str, srctext=None) -> bytes:
-        """ Match text against enabled rules (result in XML format)."""
-        root = self._get_root(self._url, self._encode(text, srctext))
-        return (b'<?xml version="1.0" encoding="UTF-8"?>\n' +
-                ElementTree.tostring(root) + b"\n")
-
     def _encode(self, text, srctext=None):
         params = {'language': self.language, 'text': text.encode('utf-8')}
         if srctext is not None:
@@ -409,12 +398,12 @@ def _start_local_server(cls):
             data = urllib.parse.urlencode(params).encode()
             try:
                 with urlopen(cls._url, data, cls._TIMEOUT) as f:
-                    tree = ElementTree.parse(f)
+                    data = json.loads(f)
             except (IOError, http.client.HTTPException) as e:
                 if err:
                     raise err
                 raise ServerError('{}: {}'.format(cls._url, e))
-            root = tree.getroot()
+            root = data
 
             # LanguageTool 1.9+
             if root.get('software') != 'LanguageTool':

language_tool_python/main.py

@@ -31,8 +31,6 @@ def parse_args():
     parser.add_argument('--enabled-only', action='store_true',
                         help='disable all rules except those specified in '
                              '--enable')
-    parser.add_argument('--api', action='store_true',
-                        help='print results as XML')
     parser.add_argument(
         '--version', action='version',
         version='%(prog)s {}'.format(__version__),
@@ -129,9 +127,8 @@ def main():
                     return 1
                 else:
                     language = guess_language(text)
-                    if not args.api:
-                        print('Detected language: {}'.format(language),
-                              file=sys.stderr)
+                    print('Detected language: {}'.format(language),
+                          file=sys.stderr)
                     if not language:
                         return 1
                     lang_tool.language = language
@@ -146,9 +143,7 @@ def main():
         lang_tool.enabled_only = args.enabled_only
 
         try:
-            if args.api:
-                print_unicode(lang_tool._check_api(text).decode())
-            elif args.apply:
+            if args.apply:
                 print_unicode(lang_tool.correct(text))
             else:
                 for match in lang_tool.check(text):

setup.cfg

@@ -19,4 +19,4 @@ classifier=
 packages=
     language_tool_python
     language_tool_python.backports
-package_data=
+package_data=