Include readme in package metadata

computationalmodelling · Jun 4, 2018 · a07335d · a07335d
1 parent a4db7db
commit a07335d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/setup.py b/setup.py
@@ -2,11 +2,16 @@
 
 from nbval._version import __version__
 
+with open('README.md') as f:
+    readme = f.read()
+
 setup(
     name="nbval",
     version=__version__,
     author="Laslett, Cortes, Fauske, Kluyver, Pepper, Fangohr",
     description='A py.test plugin to validate Jupyter notebooks',
+    long_description=readme,
+    long_description_content_type="text/markdown",
     packages = ['nbval'],
     url='https://github.com/computationalmodelling/nbval',
     # the following makes a plugin available to pytest