Skip to content

Commit c02bc99

Browse files
committed
REL: add long_description to setup.py
twine requires it for setting project description on PyPI.
1 parent 80be686 commit c02bc99

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

setup.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,9 @@ def getversioncfg():
137137

138138
versiondata = getversioncfg()
139139

140+
with open(os.path.join(MYDIR, 'README.rst')) as fp:
141+
long_description = fp.read()
142+
140143
# define distribution
141144
setup_args = dict(
142145
name = "diffpy.srreal",
@@ -157,6 +160,8 @@ def getversioncfg():
157160
maintainer_email = "[email protected]",
158161
description = ("calculators for PDF, bond valence sum, and other "
159162
"quantities based on atom pair interaction."),
163+
long_description = long_description,
164+
long_description_content_type = 'text/x-rst',
160165
license = 'BSD-style license',
161166
url = "https://github.com/diffpy/diffpy.srreal/",
162167
keywords = "PDF BVS atom overlap calculator real-space",

0 commit comments

Comments
 (0)