open.source/magic-wormhole
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add long_description_content_type to setup.py

Browse Source 
The new PyPI code discards long_description when it's not valid ReStructuredText.  Luckily it also supports Markdown, but you have to [specify the content type](https://packaging.python.org/tutorials/packaging-projects/#creating-setup-py) explicitly in that case.

(IIRC for this to work correctly you also have to use sufficiently recent versions of setuptools and twine to upload releases.)

Should fix #303.
This commit is contained in:
Marius Gedminas 2018-06-12 14:08:34 +03:00 committed by GitHub
parent 6f42433c57
commit 21dbf00a7f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
setup.py
View File

@ -18,6 +18,7 @@ setup(name="magic-wormhole",
version=versioneer.get_version(), version=versioneer.get_version(),
description="Securely transfer data between computers", description="Securely transfer data between computers",
long_description=open('README.md', 'rU').read(), long_description=open('README.md', 'rU').read(),
long_description_content_type='text/markdown',
author="Brian Warner", author="Brian Warner",
author_email="warner-magic-wormhole@lothar.com", author_email="warner-magic-wormhole@lothar.com",
license="MIT", license="MIT",