Add a long description in setup.py (displayed on PyPI)

marcelm · Sep 21, 2016 · 24d8970 · 24d8970
1 parent 32ac59c
commit 24d8970
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -33,7 +33,7 @@ If you use cutadapt, please cite
 Links
 -----
 
-* `Documentation <https://cutadapt.readthedocs.org/>`_
+* `Documentation <https://cutadapt.readthedocs.io/>`_
 * `Source code <https://github.com/marcelm/cutadapt/>`_
 * `Report an issue <https://github.com/marcelm/cutadapt/issues>`_
 * `Project page on PyPI (Python package index) <https://pypi.python.org/pypi/cutadapt/>`_

diff --git a/setup.py b/setup.py
@@ -116,13 +116,17 @@ def run(self):
 cmdclass['build_ext'] = build_ext
 cmdclass['sdist'] = sdist
 
+with open('README.rst') as f:
+	long_description = f.read()
+
 setup(
 	name = 'cutadapt',
 	version = versioneer.get_version(),
 	author = 'Marcel Martin',
 	author_email = 'marcel.martin@scilifelab.se',
 	url = 'https://cutadapt.readthedocs.io/',
 	description = 'trim adapters from high-throughput sequencing reads',
+	long_description = long_description,
 	license = 'MIT',
 	cmdclass = cmdclass,
 	ext_modules = extensions,