From f68a61911dcc7cc8cb6b621add5fc4ff88501a90 Mon Sep 17 00:00:00 2001
From: Lorraine Sposto <lorraine.sposto@jpl.nasa.gov>
Date: Thu, 3 May 2018 10:50:44 -0700
Subject: [PATCH] Issue #16 - Prepare to publish AIT GUI to Pypi - Convert
 README from md to rst

---
 README.md  | 27 ---------------------------
 README.rst | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 setup.py   | 15 ++++++++++++++-
 3 files changed, 63 insertions(+), 28 deletions(-)
 delete mode 100644 README.md
 create mode 100644 README.rst

diff --git a/README.md b/README.md
deleted file mode 100644
index fc4b5e0c..00000000
--- a/README.md
+++ /dev/null
@@ -1,27 +0,0 @@
-AMMOS Instrument Toolkit (AIT) GUI
-==================================
-
-AIT GUI provides a framework for building a custom website for realtime telemetry monitoring, commanding, and other MOS operations with only minimal HTML and configuration file changes. Built on top of the AIT Core libraries, AIT GUI provides web-development friendly access to the underlying telemetry, commanding, EVR, system logging, and other AIT Core functions in addition to a suite of pre-built UI Components and a REST API to handle common MOS use cases.
-
-Getting Started
----------------
-
-You can read through the [Installation Page](http://ait-gui.readthedocs.io/en/latest/installation.html) for instruction on how to install AIT GUI.
-
-Contributing
-------------
-
-For information on how to contribute please see the [AIT GUI Contributors Guides](http://ait-gui.readthedocs.io/en/latest/contribute.html)
-
-Browser Requirements
---------------------
-
-AIT GUI requires one of the following browsers:
-
-- Firefox version 52.0 or newer
-- Chrome version 57.0 or newer
-
-Safari v10.1 or newer will likely work as well but compatibility is not regularly checked or guaranteed.
-
------
-[![Build Status](https://travis-ci.org/NASA-AMMOS/AIT-GUI.svg?branch=master)](https://travis-ci.org/NASA-AMMOS/AIT-GUI) [![Documentation Status](https://readthedocs.org/projects/ait-gui/badge/?version=master)](http://ait-gui.readthedocs.io/en/master/?badge=master)
diff --git a/README.rst b/README.rst
new file mode 100644
index 00000000..a18b421f
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,49 @@
+AMMOS Instrument Toolkit (AIT) GUI
+==================================
+
+AIT GUI provides a framework for building a custom website for realtime
+telemetry monitoring, commanding, and other MOS operations with only
+minimal HTML and configuration file changes. Built on top of the AIT
+Core libraries, AIT GUI provides web-development friendly access to the
+underlying telemetry, commanding, EVR, system logging, and other AIT
+Core functions in addition to a suite of pre-built UI Components and a
+REST API to handle common MOS use cases.
+
+Getting Started
+---------------
+
+You can read through the `Installation
+Page <http://ait-gui.readthedocs.io/en/latest/installation.html>`__ for
+instruction on how to install AIT GUI.
+
+Contributing
+------------
+
+For information on how to contribute please see the `AIT GUI
+Contributors
+Guides <http://ait-gui.readthedocs.io/en/latest/contribute.html>`__
+
+Browser Requirements
+--------------------
+
+AIT GUI requires one of the following browsers:
+
+-  Firefox version 52.0 or newer
+-  Chrome version 57.0 or newer
+
+Safari v10.1 or newer will likely work as well but compatibility is not
+regularly checked or guaranteed.
+
+--------------
+
+|travis|
+|docs|
+
+.. |travis| image:: https://travis-ci.org/NASA-AMMOS/AIT-GUI.svg?branch=master
+    :alt: build status
+    :scale: 100%
+    :target: https://travis-ci.org/NASA-AMMOS/AIT-GUI
+.. |docs| image:: https://readthedocs.org/projects/ait-gui/badge/?version=master
+    :alt: Documentation Status
+    :scale: 100%
+    :target: https://ait-gui.readthedocs.io/en/latest/?badge=master
diff --git a/setup.py b/setup.py
index 5d8db213..965bea11 100644
--- a/setup.py
+++ b/setup.py
@@ -16,9 +16,18 @@
 from setuptools.command.install import install
 from setuptools.command.develop import develop
 
+import io
 import os
 import subprocess
 
+description = "A framework for building a custom website for realtime telemetry monitoring, commanding, and other MOS " \
+              "operations, built atop the AIT Core libraries."
+
+# Get the long description from the README file
+here = os.path.abspath(os.path.dirname(__file__))
+with io.open(os.path.join(here, 'README.rst'), encoding='utf-8') as f:
+    long_description = f.read()
+
 def install_ui_deps():
     try:
         FNULL = open(os.devnull, 'wb')
@@ -77,8 +86,12 @@ def run(self):
 setup(
     name = 'bliss-gui',
     version = '0.24.0',
+    description = description,
+    long_description = long_description,
+    long_description_content_type = 'text/x-rst',
+    url = 'https://github.com/NASA-AMMOS/AIT-GUI',
     packages = find_packages(exclude=['tests']),
-    author = 'BLISS-Core Development Team',
+    author = 'AMMOS Instrument Toolkit Development Team',
     author_email = 'bliss@jpl.nasa.gov',
 
     namespace_packages   = ['bliss'],