Adding README text to setup's long description

fif911 · Aug 27, 2023 · 86b103f · 86b103f
1 parent 215b4fa
commit 86b103f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/.github/workflows/black.yaml b/.github/workflows/black.yaml
@@ -9,4 +9,4 @@ jobs:
         steps:
             - uses: actions/checkout@v2
             - uses: actions/setup-python@v2
-            - uses: psf/black@20.8b1
+            - uses: psf/black@23.7.0
diff --git a/setup.py b/setup.py
@@ -75,6 +75,15 @@
     ext_modules_list = []
 
 
+# grab the README.md text
+this_dir = os.path.abspath(os.path.dirname(__file__))
+try:
+    with open(os.path.join(this_dir, "README.md")) as f:
+        readme = f.read()
+except IOError:
+    readme = ""
+
+
 # perform the actual build/install
 setup(
     cmdclass=cmdclass,
@@ -102,7 +111,7 @@
     ],
     python_requires=">=3.4, <3.12",
     license="MIT",
-    long_description="A Python library for creating and solving mazes.",
+    long_description=readme,
     long_description_content_type="text/markdown",
     packages=find_packages(),
     package_data={"mazelib": ["generate/*.pxd", "solve/*.pxd", "transmute/*.pxd"]},