Pull request for 0.7.4

.travis.yml

@@ -9,4 +9,5 @@ notifications:
     rooms:
       - secure: 4FRaTAAiYyeUvgw2RhmblgbNiJO4wmd34OBgWcwURjP9oVmFfSwR9r1LNCdUGxrPOghexSY2DjXIuvIrfTfi/xYbhHb3Kw7PEAyB8IuBMlKtY4NSFou62S2VhYpxyg58T+C7P2zi0eDnDE06pwTCoGPaimxMZQY91yQ0yPYDPVXbwe5SjEgamzlwGBxlS/0A6w1iCPHg27/iO2hXtdW3oLS2I0F/Q8Q95RBkX9hpg6yqHlTV7jRbSqvQ9OFBqk/tXMHQvhoPDGgCgQDuykJuaAYx7g9d0YL0eEYYOh9B/TJ/kNOwdRFBu5kuQ2/nFS5Z0S3Y3UIhdYjUmm9gSMnwIbYnrW22EqDJLoT9Zi3Gv7Prg/8/fSkWsof7BJTMSuXUqO1AxDGKIxFv9uSF1daZoY+AC1ooU1xDu1nNvWVYPlkwEdDxxmHpFkGT3ESTZYccPovQl8Z5K0I1BBAVdJKDzm07lE6VHbxkKcvK6gG0TN3uLxnSlQtjkfJ+aVMq1kxeVsB9lEsKs9oezsKzzbftMm525aXPg+OAv+31CUFWxvT/p4ps8Q+AV6aZpoPHkpK8VryyNirUeZ/m4m4ebDHhD9vcN+JqE9gzshT+0U3g19SvLiUMQtbuZ2BUvrq2hh2LEGs03AFZaNg9AEUVA1PQRhV5NILyoS/lbiBYJPT39Sg=
       - secure: D4VxkkZlj7uaaFbqEBITkJCusVeii436N8X6GijuosUSaee9lqGYUF5ZS9lV6VGMKs719IfSJsCc2v/N4nc9Y/8AKgXd7AWHUwaRR+MC6rLwv9xqH8ZlkTPUKHUXkUQe1f9042PcMxzYa9r0+uKniM9l915Yx0PLaawJrWe3ZVig/uBhn5FueLhtUACzLJcjNcri/BKEgmP2+EgUsupUhujd0MsQd8xN5YIIv6VM5oD0XWXZCnBqHoZK+Qq7LfwDnTmUk7juqTOAjefF6v8IJTDELvSdK9QW7f9x7h0ICabIrI+Gl4IbNLJYEnELBi+X7da2YJUTgUoQrlBB4z+T8KybD8myqV/pJc1n0xrk84g1MtYQ3ahZn7eD3DTjIvK+ML8qAAGwxibF8VsV+GSoo5FcB6e3vV+glHODlwszstVs11PpL1grurVdoa5HPhUbm1jtQixOwO7h8GgGpwO20PuMLfyOfTjfoMcJ3ISjGNHRmUwcCH9avcaHqMLPLHht0z+8inVlDZeTcN+Wi8tk1YXwuQYUkTW46iFmoZNGdygRjTu43h9hCqdG7vcoKrR8oDbMT8X/sfs+z/UaBbuYBr9dT8rrdKJoa9115PaYpCs529DLrw1iGmzr5CkAXDElc1y2F352nwVS+dX7/OIQz1/dbT1ozWQ9Blx6ez5XN84=
+      - secure: g/eOC2QCn7oUW234u/P1kmh9OASO9t5g6iC+DflNdnedHnpw8IEG9CsLAnNynOY0KvC/2/Q6BAIFpT/qO8BPdaC2eQnd9LDurOXExxvjKZgTujhqgzijJGzVPSL8//hafj0Ec2+iJZFo/DYMPqUpYDsiKxX53+SMz9/GN/PKVKsI7bzuaOm04xXktU0A76pVfaG0N/qFSVHI64SShACoUXRpTzyUbmksRgzk7FB162R+TH1soPsR3vPh8c2SSWC9msrDc4iljcBhSFTdjL68z+srjDPYMSoOcFXXFNP+dmL+Q0veL/E4e40e7CWIU1O3grOcEcCkaSoZVSpGduNnCst8h6MpgauPtrgwHk4zGMoSl+L6al+nFo/3h2dXeebrQ0tY/hRfZi4Q8xwqG9083TBqi71fTpoFZ7sNtrY4Kdtl5Oa2CFUo7lVn1JB9qQwSa0eai3Whv0RyRqqQe77aDUj0dfD2R3Q61rX5OF/f++W0XtNwHQubzmj8HD/cFneShIQsbl9KgYXoR6HiXcbBiNdmmZjSrzkPYh7vlsujYrz6Cg2msKybWJ/FfOz0tS1cjlCtiCMOTExN6tEF8YCp9l+s+5RLe61pgFPy4Snr9pEjuTS5DYliTyZMY2ZZC1clBQtgE8E2qCG1QSzqnqqiGxj2K4zmLPpB4y1XpW8e3yk=
 

MANIFEST.in

@@ -1,2 +1,2 @@
-include README.txt CHANGES.txt LICENSE.txt
+include README.md CHANGES.txt LICENSE.txt
 exclude MANIFEST.in

examples/base64_input.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+"""
+Example code to call Rosette API to get entities from a piece of base64-encoded text.
+"""
+
+import argparse
+import json
+import os
+import base64
+
+from rosette.api import API, DocumentParameters
+
+
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
+    # Create an API instance
+    api = API(user_key=key, service_url=altUrl)
+    params = DocumentParameters()
+    text = base64.b64encode(u"Bill Murray will appear in new Ghostbusters film: Dr. Peter Venkman was spotted filming a cameo in Boston this… http://dlvr.it/BnsFfS ")
+    params["content"] = text
+    params["contentType"] = "text/html"
+    return api.entities(params)  # entity linking is turned off
+
+parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+parser.add_argument('-k', '--key', help='Rosette API Key', required=True)
+parser.add_argument('-u', '--url', help="Alternative API URL", default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    result = run(args.key, args.url)
+    print(json.dumps(result, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))

examples/categories.py

@@ -4,20 +4,29 @@
 Example code to call Rosette API to get the category of a document (at a given URL).
 """
 
+import argparse
 import json
+import os
 
 from rosette.api import API, DocumentParameters
 
 
-def run(key):
-    url = "https://en.wikipedia.org/wiki/Basis_Technology_Corp."
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
+    url = "Sony Pictures is planning to shoot a good portion of the new "Ghostbusters" in Boston as well."
     # Create an API instance
-    api = API(user_key=key)
+    api = API(user_key=key, service_url=altUrl)
     params = DocumentParameters()
 
     # Use a URL to input data instead of a string
     params["contentUri"] = url
-    result = api.categories(params)
+    return api.categories(params)
 
-    print(json.dumps(result, indent=2, ensure_ascii=False).encode("utf8"))
-    return json.dumps(result, indent=2, ensure_ascii=False).encode("utf8")
+
+parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+parser.add_argument('-k', '--key', help='Rosette API Key', required=True)
+parser.add_argument('-u', '--url', help="Alternative API URL", default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    result = run(args.key, args.url)
+    print(json.dumps(result, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))

examples/entities.py

@@ -4,16 +4,25 @@
 Example code to call Rosette API to get entities from a piece of text.
 """
 
+import argparse
 import json
+import os
 
 from rosette.api import API, DocumentParameters
 
 
-def run(key):
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     # Create an API instance
-    api = API(user_key=key)
+    api = API(user_key=key, service_url=altUrl)
     params = DocumentParameters()
-    params["content"] = u"President Obama urges the Congress and Speaker Boehner to pass the $50 billion spending bill based on Christian faith by July 1st or Washington will become totally dysfunctional, a terrible outcome for American people."
-    result = api.entities(params)  # entity linking is turned off
-    print(json.dumps(result, indent=2, ensure_ascii=False).encode("utf8"))
-    return json.dumps(result, indent=2, ensure_ascii=False).encode("utf8")
+    params["content"] = u"Bill Murray will appear in new Ghostbusters film: Dr. Peter Venkman was spotted filming a cameo in Boston this… http://dlvr.it/BnsFfS "
+    return api.entities(params)  # entity linking is turned off
+
+parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+parser.add_argument('-k', '--key', help='Rosette API Key', required=True)
+parser.add_argument('-u', '--url', help="Alternative API URL", default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    result = run(args.key, args.url)
+    print(json.dumps(result, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))

examples/entities_linked.py

@@ -4,18 +4,27 @@
 Example code to call Rosette API to get linked (against Wikipedia) entities from a piece of text.
 """
 
+import argparse
 import json
+import os
 
 from rosette.api import API, DocumentParameters
 
 
-def run(key):
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     # Create an API instance
-    api = API(user_key=key)
+    api = API(user_key=key, service_url=altUrl)
 
     params = DocumentParameters()
-    params["content"] = u"President Obama urges the Congress and Speaker Boehner to pass the $50 billion spending bill based on Christian faith by July 1st or Washington will become totally dysfunctional, a terrible outcome for American people."
-    result = api.entities(params, True)  # entity linking is turned on
+    params["content"] = u"Last month director Paul Feig announced the movie will have an all-star female cast including Kristen Wiig, Melissa McCarthy, Leslie Jones and Kate McKinnon."
+    return api.entities(params, True)  # entity linking is turned on
 
-    print(json.dumps(result, indent=2, ensure_ascii=False).encode("utf8"))
-    return json.dumps(result, indent=2, ensure_ascii=False).encode("utf8")
+
+parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+parser.add_argument('-k', '--key', help='Rosette API Key', required=True)
+parser.add_argument('-u', '--url', help="Alternative API URL", default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    result = run(args.key, args.url)
+    print(json.dumps(result, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))

examples/info.py

@@ -4,16 +4,25 @@
 Example code to call Rosette API to get information such as version and build
 """
 
+import argparse
 import json
+import os
 
 from rosette.api import API, DocumentParameters
 
 
-def run(key):
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     # Create an API instance
-    api = API(user_key=key)
+    api = API(user_key=key, service_url=altUrl)
 
-    result = api.info()
+    return api.info()
 
-    print(json.dumps(result, indent=2, ensure_ascii=False).encode("utf8"))
-    return json.dumps(result, indent=2, ensure_ascii=False).encode("utf8")
+
+parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+parser.add_argument('-k', '--key', help='Rosette API Key', required=True)
+parser.add_argument('-u', '--url', help="Alternative API URL", default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    result = run(args.key, args.url)
+    print(json.dumps(result, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))

examples/language.py

@@ -4,19 +4,28 @@
 Example code to call Rosette API to determine the language of a piece of text.
 """
 
+import argparse
 import json
+import os
 
 from rosette.api import API, DocumentParameters
 
 
-def run(key):
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     # Create an API instance
-    api = API(user_key=key)
+    api = API(user_key=key, service_url=altUrl)
 
     params = DocumentParameters()
 
     params["content"] = u"Por favor Señorita, says the man."
-    result = api.language(params)
+    return api.language(params)
 
-    print(json.dumps(result, indent=2, ensure_ascii=False).encode("utf8"))
-    return json.dumps(result, indent=2, ensure_ascii=False).encode("utf8")
+
+parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+parser.add_argument('-k', '--key', help='Rosette API Key', required=True)
+parser.add_argument('-u', '--url', help="Alternative API URL", default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    result = run(args.key, args.url)
+    print(json.dumps(result, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))

examples/matched-name.py

@@ -4,19 +4,28 @@
 Example code to call Rosette API to get match score (similarity) of two names.
 """
 
+import argparse
 import json
+import os
 
 from rosette.api import API, NameMatchingParameters
 
 
-def run(key):
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     # Create an API instance
-    api = API(user_key=key)
+    api = API(user_key=key, service_url=altUrl)
 
     params = NameMatchingParameters()
     params["name1"] = {"text": "Michael Jackson", "language": "eng", "entityType": "PERSON"}
     params["name2"] = {"text": "迈克尔·杰克逊", "entityType": "PERSON"}
-    result = api.matched_name(params)
+    return api.matched_name(params)
 
-    print(json.dumps(result, indent=2, ensure_ascii=False).encode("utf8"))
-    return json.dumps(result, indent=2, ensure_ascii=False).encode("utf8")
+
+parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+parser.add_argument('-k', '--key', help='Rosette API Key', required=True)
+parser.add_argument('-u', '--url', help="Alternative API URL", default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    result = run(args.key, args.url)
+    print(json.dumps(result, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))

examples/morphology_complete.py

@@ -4,18 +4,27 @@
 Example code to call Rosette API to get the complete morphological analysis of a piece of text.
 """
 
+import argparse
 import json
+import os
 
 from rosette.api import API, DocumentParameters
 
 
-def run(key):
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     # Create an API instance
-    api = API(user_key=key)
+    api = API(user_key=key, service_url=altUrl)
 
     params = DocumentParameters()
     params["content"] = u"The quick brown fox jumped over the lazy dog. Yes he did."
-    result = api.morphology(params)
+    return api.morphology(params)
 
-    print(json.dumps(result, indent=2, ensure_ascii=False).encode("utf8"))
-    return json.dumps(result, indent=2, ensure_ascii=False).encode("utf8")
+
+parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+parser.add_argument('-k', '--key', help='Rosette API Key', required=True)
+parser.add_argument('-u', '--url', help="Alternative API URL", default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    result = run(args.key, args.url)
+    print(json.dumps(result, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))

examples/morphology_compound-components.py

@@ -4,18 +4,27 @@
 Example code to call Rosette API to get de-compounded words from a piece of text.
 """
 
+import argparse
 import json
+import os
 
 from rosette.api import API, DocumentParameters, MorphologyOutput
 
 
-def run(key):
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     # Create an API instance
-    api = API(user_key=key)
+    api = API(user_key=key, service_url=altUrl)
 
     params = DocumentParameters()
     params["content"] = u"Rechtsschutzversicherungsgesellschaften"
-    result = api.morphology(params, MorphologyOutput.COMPOUND_COMPONENTS)
+    return api.morphology(params, MorphologyOutput.COMPOUND_COMPONENTS)
 
-    print(json.dumps(result, indent=2, ensure_ascii=False).encode("utf8"))
-    return json.dumps(result, indent=2, ensure_ascii=False).encode("utf8")
+
+parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+parser.add_argument('-k', '--key', help='Rosette API Key', required=True)
+parser.add_argument('-u', '--url', help="Alternative API URL", default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    result = run(args.key, args.url)
+    print(json.dumps(result, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))

examples/morphology_han-readings.py

@@ -4,18 +4,27 @@
 Example code to call Rosette API to get Chinese readings of words in a piece of text.
 """
 
+import argparse
 import json
+import os
 
 from rosette.api import API, DocumentParameters, MorphologyOutput
 
 
-def run(key):
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     # Create an API instance
-    api = API(user_key=key)
+    api = API(user_key=key, service_url=altUrl)
 
     params = DocumentParameters()
     params["content"] = u"北京大学生物系主任办公室内部会议"
-    result = api.morphology(params, MorphologyOutput.HAN_READINGS)
+    return api.morphology(params, MorphologyOutput.HAN_READINGS)
 
-    print(json.dumps(result, indent=2, ensure_ascii=False).encode("utf8"))
-    return json.dumps(result, indent=2, ensure_ascii=False).encode("utf8")
+
+parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+parser.add_argument('-k', '--key', help='Rosette API Key', required=True)
+parser.add_argument('-u', '--url', help="Alternative API URL", default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    result = run(args.key, args.url)
+    print(json.dumps(result, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))

examples/morphology_lemmas.py

@@ -4,18 +4,27 @@
 Example code to call Rosette API to get lemmas for words in a piece of text.
 """
 
+import argparse
 import json
+import os
 
 from rosette.api import API, DocumentParameters, MorphologyOutput
 
 
-def run(key):
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     # Create an API instance
-    api = API(user_key=key)
+    api = API(user_key=key, service_url=altUrl)
 
     params = DocumentParameters()
     params["content"] = u"The fact is that the geese just went back to get a rest and I'm not banking on their return soon"
-    result = api.morphology(params, MorphologyOutput.LEMMAS)
+    return api.morphology(params, MorphologyOutput.LEMMAS)
 
-    print(json.dumps(result, indent=2, ensure_ascii=False).encode("utf8"))
-    return json.dumps(result, indent=2, ensure_ascii=False).encode("utf8")
+
+parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+parser.add_argument('-k', '--key', help='Rosette API Key', required=True)
+parser.add_argument('-u', '--url', help="Alternative API URL", default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    result = run(args.key, args.url)
+    print(json.dumps(result, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))