Merge pull request #874 from MSeal/long_description

Added long description to setuptools for new pypi page

setup.py

@@ -29,6 +29,7 @@
 
 import os
 import setuptools
+import io
 
 from setuptools.command.bdist_egg import bdist_egg
 
@@ -74,10 +75,10 @@ class FetchCSS(Command):
     user_options = []
     def initialize_options(self):
         pass
-    
+
     def finalize_options(self):
         pass
-    
+
     def _download(self):
         try:
             return urlopen(css_url).read()
@@ -92,7 +93,7 @@ def _download(self):
                     print("Failed, trying again with PycURL to avoid outdated SSL.", file=sys.stderr)
                     return self._download_pycurl()
             raise e
-    
+
     def _download_pycurl(self):
         """Download CSS with pycurl, in case of old SSL (e.g. Python < 2.7.9)."""
         import pycurl
@@ -102,7 +103,7 @@ def _download_pycurl(self):
         c.setopt(c.WRITEDATA, buf)
         c.perform()
         return buf.getvalue()
-    
+
     def run(self):
         dest = os.path.join('nbconvert', 'resources', 'style.min.css')
         if not os.path.exists('.git') and os.path.exists(dest):
@@ -119,7 +120,7 @@ def run(self):
             else:
                 raise OSError("Need Notebook CSS to proceed: %s" % dest)
             return
-        
+
         with open(dest, 'wb') as f:
             f.write(css)
         print("Downloaded Notebook CSS to %s" % dest)
@@ -128,7 +129,7 @@ def run(self):
 
 class bdist_egg_disabled(bdist_egg):
     """Disabled version of bdist_egg
- 
+
     Prevents setup.py install performing setuptools' default easy_install,
     which it should never ever do.
     """
@@ -156,10 +157,14 @@ def run(self):
 with open(pjoin(here, name, '_version.py')) as f:
     exec(f.read(), {}, version_ns)
 
+with io.open(pjoin(here, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
 
 setup_args = dict(
     name            = name,
     description     = "Converting Jupyter Notebooks",
+    long_description    = long_description,
+    long_description_content_type   = 'text/markdown',
     version         = version_ns['__version__'],
     scripts         = glob(pjoin('scripts', '*')),
     packages        = packages,
@@ -206,9 +211,9 @@ def run(self):
     'test': ['pytest', 'pytest-cov', 'ipykernel', jupyter_client_req],
     'serve': ['tornado>=4.0'],
     'execute': [jupyter_client_req],
-    'docs': ['sphinx>=1.5.1', 
+    'docs': ['sphinx>=1.5.1',
              'sphinx_rtd_theme',
-             'nbsphinx>=0.2.12', 
+             'nbsphinx>=0.2.12',
              'sphinxcontrib_github_alt',
              'ipython',
              jupyter_client_req,
@@ -237,7 +242,7 @@ def run(self):
             'rst=nbconvert.exporters:RSTExporter',
             'notebook=nbconvert.exporters:NotebookExporter',
             'asciidoc=nbconvert.exporters:ASCIIDocExporter',
-            'script=nbconvert.exporters:ScriptExporter'] 
+            'script=nbconvert.exporters:ScriptExporter']
     }
     setup_args.pop('scripts', None)