update documentation and add link to public api

Author: jxmorris12

README.md

@@ -2,6 +2,33 @@
 
 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:

language_tool_python/__init__.py

@@ -7,5 +7,5 @@
 
 from .language_tag import LanguageTag
 from .match import Match
-from .server import LanguageTool
+from .server import LanguageTool, LanguageToolPublicAPI
 from . import utils

language_tool_python/__main__.py

@@ -60,7 +60,6 @@ def parse_args():
 
 
 class RulesAction(argparse.Action):
-
     def __call__(self, parser, namespace, values, option_string=None):
         getattr(namespace, self.dest).update(values)
 
@@ -103,9 +102,10 @@ def main():
             encoding = args.encoding or 'utf-8'
 
         remote_server = None
-        if args.remote_host is not None and args.remote_port is not None:
-            remote_server = {'host': args.remote_host,
-                             'port': args.remote_port}
+        if args.remote_host is not None:
+            remote_server = args.remote_host
+            if args.remote_port is not None:
+                remote_server += ':{}'.format(args.remote_port)
         lang_tool = LanguageTool(
             motherTongue=args.mother_tongue,
             remote_server=remote_server,

language_tool_python/server.py

@@ -13,8 +13,6 @@
 from .match import Match
 from .utils import *
 
-download_lt()
-
 class LanguageTool:
 
     """Main class used for checking text against different rules."""
@@ -33,9 +31,8 @@ class LanguageTool:
     def __init__(self, language=None, motherTongue=None, remote_server=None):
         if remote_server is not None:
             self._remote = True
-            self._HOST = remote_server["host"]
-            self._port = remote_server["port"]
-            self._url = 'http://{}:{}/v2/'.format(self._HOST, self._port)
+            if remote_server[-1] == '/': remote_server = remote_server[:-1]
+            self._url = '{}/v2/'.format(remote_server)
             self._update_remote_server_config(self._url)
         elif not self._server_is_alive():
             self._start_server_on_free_port()
@@ -151,6 +148,9 @@ def _get_attrib(cls):
 
     @classmethod
     def _start_server_if_needed(cls):
+        # Download language tool if needed.
+        download_lt()
+        # Start server.
         if not cls._server_is_alive() and cls._remote is False:
             cls._start_server_on_free_port()
 
@@ -294,6 +294,11 @@ def _terminate_server(cls):
         return LanguageToolError_message
 
 
+class LanguageToolPublicAPI(LanguageTool):
+    """  Language tool client of the official API. """
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, remote_server='https://api.languagetool.org', **kwargs)
+
 @atexit.register
 def terminate_server():
     """Terminate the server."""
@@ -310,4 +315,4 @@ def _consume(stdout):
 
     """
     while stdout.readline():
-        pass
+        pass