Rearrangement of documentation. Fixed an encoding issue in setup.py.

README.rst

@@ -30,11 +30,11 @@ possible to independently integrate own solutions.
    :alt: Illustration of Palladium
 |
 
-Much of Palladium's functionality is based on the **scikit-learn** library.
-Thus, a lot of times you will find yourself looking at the
+Much of Palladium's functionality is based on the **scikit-learn**
+library.  Thus, a lot of times you will find yourself looking at the
 `documentation for scikit-learn <http://scikit-learn.org/>`_ when
-developing with Palladium.  Although being implemented in Python, Model
-Stack provides support for other languages and is shipped with
+developing with Palladium.  Although being implemented in Python,
+Palladium provides support for other languages and is shipped with
 examples how to **integrate and expose R and Julia models**.
 
 For an efficient deployment of services based on Palladium, a script to
@@ -56,47 +56,3 @@ Links
 - Source code repository at GitHub: https://github.com/ottogroup/palladium
 - Documentation including installation instructions and tutorial: http://palladium.readthedocs.org
 - Maintainer: `Andreas Lattner <https://github.com/alattner>`_
-
-
-Related Projects
-----------------
-
-There are a number of other interesting projects out there which have
-some features in common with Palladium. In the following, we will mention a
-selection.
-
-- `DOMINO <http://www.dominodatalab.com>`_
-
-  Infrastructure for data analysis (PaaS). A UI for running and
-  examining experiments is provided. Experiments can be run in
-  parallel and notification mechanisms can be set up. Models can be
-  deployed as web services (referring to DOMINO's documentation, the
-  overhead for the HTTP server is about 150ms) and model updates can
-  be scheduled. Supports Python, R, Julia, Octave, and SAS
-  models. Commercial.
-
-- `PredictionIO <http://prediction.io>`_
-
-  ML server based on Hadoop / Spark. Two engine templates for Apache
-  Spark MLlib are provided for setting up a recommendation engine or a
-  classification engine. It also allows for gathering new
-  events. Supports Spark MLlib and Scala models (no support for
-  Python, R, Julia). Open source.
-
-
-- `Scikit-Learn Laboratory
-  <http://https://github.com/EducationalTestingService/skll>`_
-
-  Tool to support experiments performed with scikit-learn. It allows
-  to run various settings on different test sets and to get a summary
-  of the test's results. It does not aim at exposing models as web
-  services. Supports Python models (no support for R or Julia). Open
-  source.
-
-- `yhat ScienceOps <http://yhathq.com>`_
-
-  Platform for managing predictive models in production environments
-  (PaaS). A command line tool and GUI are available for model
-  management. It also provides a Load Balancer and can automatically
-  scale the servers as needed. Supports Python and R
-  models. Commercial.

docs/index.rst

@@ -31,11 +31,11 @@ possible to independently integrate own solutions.
    :alt: Illustration of Palladium
 |
 
-Much of Palladium's functionality is based on the **scikit-learn** library.
-Thus, a lot of times you will find yourself looking at the
+Much of Palladium's functionality is based on the **scikit-learn**
+library.  Thus, a lot of times you will find yourself looking at the
 `documentation for scikit-learn <http://scikit-learn.org/>`_ when
-developing with Palladium.  Although being implemented in Python, Model
-Stack provides support for other languages and is shipped with
+developing with Palladium.  Although being implemented in Python,
+Palladium provides support for other languages and is shipped with
 examples how to **integrate and expose R and Julia models**.
 
 For an efficient deployment of services based on Palladium, a script to
@@ -71,6 +71,7 @@ application.
   user/R
   user/julia
   user/faq
+  user/related-projects
 
 API Reference
 -------------
@@ -83,6 +84,7 @@ method, this part of the documentation is for you.
 
   modules/palladium
 
+
 Indices and tables
 ------------------
 

docs/user/related-projects.rst

@@ -0,0 +1,43 @@
+================
+Related projects
+================
+
+There are a number of other interesting projects out there which have
+some features in common with Palladium. In the following, we will mention a
+selection.
+
+- `DOMINO <http://www.dominodatalab.com>`_
+
+  Infrastructure for data analysis (PaaS). A UI for running and
+  examining experiments is provided. Experiments can be run in
+  parallel and notification mechanisms can be set up. Models can be
+  deployed as web services (referring to DOMINO's documentation, the
+  overhead for the HTTP server is about 150ms) and model updates can
+  be scheduled. Supports Python, R, Julia, Octave, and SAS
+  models. Commercial.
+
+- `PredictionIO <http://prediction.io>`_
+
+  ML server based on Hadoop / Spark. Two engine templates for Apache
+  Spark MLlib are provided for setting up a recommendation engine or a
+  classification engine. It also allows for gathering new
+  events. Supports Spark MLlib and Scala models (no support for
+  Python, R, Julia). Open source.
+
+
+- `Scikit-Learn Laboratory
+  <http://https://github.com/EducationalTestingService/skll>`_
+
+  Tool to support experiments performed with scikit-learn. It allows
+  to run various settings on different test sets and to get a summary
+  of the test's results. It does not aim at exposing models as web
+  services. Supports Python models (no support for R or Julia). Open
+  source.
+
+- `yhat ScienceOps <http://yhathq.com>`_
+
+  Platform for managing predictive models in production environments
+  (PaaS). A command line tool and GUI are available for model
+  management. It also provides a Load Balancer and can automatically
+  scale the servers as needed. Supports Python and R
+  models. Commercial.

setup.py

@@ -26,15 +26,27 @@
 
 here = os.path.abspath(os.path.dirname(__file__))
 try:
-    README = open(os.path.join(here, 'README.rst')).read()
-    CHANGES = open(os.path.join(here, 'CHANGES.txt')).read()
+    README = open(os.path.join(here, 'README.rst'), encoding='utf-8').read()
+    CHANGES = open(os.path.join(here, 'CHANGES.txt'), encoding='utf-8').read()
 except IOError:
     README = CHANGES = ''
 
 
 setup(name='palladium',
       version=version,
-      description='',
+      description='Framework for setting up predictive analytics services',
+      long_description=README,
+      url='https://github.com/ottogroup/palladium',
+      author='Otto Group',
+      author_email='palladium@ottogroup.com',
+      license='Apache License, Version 2.0',
+      classifiers=[
+          'Development Status :: 5 - Production/Stable',
+          'Intended Audience :: Developers',
+          'License :: OSI Approved :: Apache Software License',
+          'Programming Language :: Python :: 3.3',
+          'Programming Language :: Python :: 3.4',
+      ],
       packages=find_packages(),
       include_package_data=True,
       zip_safe=False,