Add PyPI installation and online doc site

Donald Szeto · Donald Szeto · commit 4f97aae867a5 · 2013-03-21T23:46:36.000+08:00
diff --git a/README.txt b/README.txt
@@ -4,9 +4,20 @@ PredictionIO Python SDK
 Install
 --------
 
-To install this predictionio package, run,
+To install the module from PyPI, you may
 
-    % python setup.py install
+    $ pip install predictionio
+
+or
+
+    $ easy_install predictionio
+
+If you have cloned the repository and want to install directly from there,
+do the following in the root directory of the repository:
+
+    $ python setup.py install
+
+This will install the "predictionio" module to your Python distribution.
 
 Usage
 -----
@@ -15,11 +26,13 @@ To use predictionio in your Python script,
 
     >>> import predictionio
 
-
 Documentation
 -------------
 
-Please install Sphinx (http://sphinx-doc.org/install.html) if you do not have it.
+The latest documentation is located at http://pythonhosted.org/PredictionIO/
+
+If you want to build a local copy, please install Sphinx
+(http://sphinx-doc.org/install.html).
 
 To generate documentation,
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,17 +7,31 @@ Overview
 Installation
 ------------
 
-Go to the containing directory PredictionIO-Python-SDK/lib and execute the following::
+To install the module from PyPI, you may
 
-   $ python setup.py install
+::
 
-This will install the predictionio Python-SDK package into the corresponding package directory.
+    $ pip install predictionio
+
+or
+
+::
+
+    $ easy_install predictionio
+
+If you have cloned the repository and want to install directly from there,
+do the following in the root directory of the repository::
+
+    $ python setup.py install
+
+This will install the ``predictionio`` module to your Python distribution.
 
 
 Usage
--------------
+-----
 
-To start using this Python SDK, simply import the installed predictionio package in your Python environment::
+To start using this Python SDK, simply import the ``predictionio`` module in
+your Python program::
 
     >>> import predictionio
 
diff --git a/docs/source/predictionio.rst b/docs/source/predictionio.rst
@@ -41,7 +41,7 @@ Error Handling
 An exception will be raised when an error occur during the request. Please refer to the documentation of the :class:`predictionio.Client` class for details.
 In general, you may want to catch the exception and decide what to do with the error (such as logging it).
 
-For example, the method :meth:`~Client.user_rate_item` may raise U2IActionNotCreatedError.
+For example, the method :meth:`~Client.user_rate_item` may raise ``U2IActionNotCreatedError``.
 
    >>> try:
    >>>   client.user_rate_item(uid="100", iid="200", rate=2)
