Include README.md in package metadata (fix kerrickstaley#110) (kerric…

…kstaley#113) Uses the method described in the Python Packaging User Guide: https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/#including-your-readme-in-your-package-s-metadata
zhaisilong · Dec 16, 2022 · da9e5a6 · da9e5a6
1 parent 336b666
commit da9e5a6
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/setup.py b/setup.py
@@ -1,12 +1,18 @@
 from setuptools import setup
+from pathlib import Path
 
 version = {}
 with open('genanki/version.py') as fp:
   exec(fp.read(), version)
 
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+
 setup(name='genanki',
       version=version['__version__'],
       description='Generate Anki decks programmatically',
+      long_description=long_description,
+      long_description_content_type='text/markdown',
       url='http://github.com/kerrickstaley/genanki',
       author='Kerrick Staley',
       author_email='[email protected]',