Merge pull request #37 from bjlittle/add-long-description

Add long_description to setup.py

Author: lbdreyer

README.md

@@ -1,19 +1,20 @@
 # Stratify
 
-[![Build Status](https://travis-ci.org/SciTools-incubator/python-stratify.svg?branch=master)](https://travis-ci.org/SciTools-incubator/python-stratify) [![Binder](http://mybinder.org/badge.svg)](http://mybinder.org:/repo/scitools-incubator/python-stratify)
+[![Build Status](https://travis-ci.org/SciTools-incubator/python-stratify.svg?branch=master)](https://travis-ci.org/SciTools-incubator/python-stratify)
+[![Binder](http://mybinder.org/badge.svg)](http://mybinder.org:/repo/scitools-incubator/python-stratify)
 
 Interpolation for restratification, particularly useful for Nd vertical interpolation of atmospheric and oceanographic datasets
 
 ## Introduction
 
-Discover the capabilites of `stratify` with this introductory [notebook](index.ipynb).
+Discover the capabilites of `stratify` with this introductory [notebook](https://nbviewer.jupyter.org/github/SciTools-incubator/SciTools-incubator.github.io/blob/python-stratify/index.ipynb).
 
-[![An outline of the problem space](summary.png)](index.ipynb)
+![](https://SciTools-incubator.github.io/python-stratify/summary.png)
 
 ## Installation
 
 ```shell
-conda install -c scitools python-stratify
+conda install -c conda-forge python-stratify
 ```
 
 ## License

setup.py

@@ -46,6 +46,13 @@ def extract_version():
     return version
 
 
+def long_description():
+    fname = os.path.join(PACKAGE_DIR, 'README.md')
+    with open(fname, 'rb') as fi:
+        result = fi.read().decode('utf-8')
+    return result
+
+
 # Python 2 is not supported by numpy as of version 1.17
 # but pip will attempt to install/use newer Python 3-only numpy versions.
 numpy_req = 'numpy<1.17' if sys.version_info.major < 3 else 'numpy'
@@ -74,6 +81,8 @@ def extract_version():
     description=('Vectorized interpolators that are especially useful for '
                  'Nd vertical interpolation/stratification of atmospheric '
                  'and oceanographic datasets'),
+    long_description=long_description(),
+    long_description_content_type='text/markdown',
     author='UK Met Office',
     author_email='scitools-iris-dev@googlegroups.com',
     url='https://github.com/SciTools-incubator/python-stratify',