Skip to content

Commit 86b103f

Browse files
committed
Adding README text to setup's long description
1 parent 215b4fa commit 86b103f

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

.github/workflows/black.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ jobs:
99
steps:
1010
- uses: actions/checkout@v2
1111
- uses: actions/setup-python@v2
12-
- uses: psf/black@20.8b1
12+
- uses: psf/black@23.7.0

setup.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,15 @@
7575
ext_modules_list = []
7676

7777

78+
# grab the README.md text
79+
this_dir = os.path.abspath(os.path.dirname(__file__))
80+
try:
81+
with open(os.path.join(this_dir, "README.md")) as f:
82+
readme = f.read()
83+
except IOError:
84+
readme = ""
85+
86+
7887
# perform the actual build/install
7988
setup(
8089
cmdclass=cmdclass,
@@ -102,7 +111,7 @@
102111
],
103112
python_requires=">=3.4, <3.12",
104113
license="MIT",
105-
long_description="A Python library for creating and solving mazes.",
114+
long_description=readme,
106115
long_description_content_type="text/markdown",
107116
packages=find_packages(),
108117
package_data={"mazelib": ["generate/*.pxd", "solve/*.pxd", "transmute/*.pxd"]},

0 commit comments

Comments
 (0)