Set project long_description

griffithlab · Apr 19, 2024 · 6f95082 · 6f95082
1 parent ea48db2
commit 6f95082
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/setup.py b/setup.py
@@ -1,5 +1,9 @@
 from setuptools import setup
 from civicpy.__version__ import __version__, __authors__, __author_email__, __description__, __url__
+from pathlib import Path
+
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
 
 setup(
     name='civicpy',
@@ -10,6 +14,8 @@
     author=', '.join(__authors__),
     author_email=__author_email__,
     description=__description__,
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     classifiers=[
         'Development Status :: 3 - Alpha',
         'Intended Audience :: Science/Research',