setup.py: properly mark long_description as Markdown

This looks hacky, but it is the officially recommended way: https://packaging.python.org/guides/making-a-pypi-friendly-readme/
f-droid · Oct 8, 2020 · 4d92c1c · 4d92c1c
1 parent ead5fd5
commit 4d92c1c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/setup.cfg b/setup.cfg
@@ -23,8 +23,7 @@ description-file = README.md
 license_file = LICENSE
 
 
-# uploading here requires Python 3.5.3+ or setuptools 27+,
-# use instead: twine upload --sign dist/fdroidserver*.tar.gz
+# post release files with: twine upload --sign dist/repomaker-*.tar.gz
 [aliases]
 release = version_check repomaker_static_check compile_catalog sdist
 

diff --git a/setup.py b/setup.py
@@ -48,11 +48,16 @@ def run(self):
 packages = find_packages()
 print("Packages: %s" % str(packages))
 
+with open(os.path.join(os.path.abspath(os.path.dirname(__file__)), 'README.md')) as f:
+    long_description = f.read()
+
 setup(
     name='repomaker',
     version=VERSION,
     packages=packages + ['repomaker-static'],
     description='Create F-Droid repositories with ease',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     license='AGPL-3.0',
     url='https://f-droid.org/repomaker/',
     python_requires='>=3',