Skip to content

Commit ec33046

Browse files
authored
build: include README in built dist (#5)
1 parent e23eabe commit ec33046

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

Diff for: setup.py

+5-2
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,18 @@ def get_tag(self):
7878
return python, abi, plat
7979

8080

81-
long_description = """\
82-
redshift_connector is a Pure-Python interface to the Amazon Redshift. """
81+
# read the contents of your README file
82+
this_directory = os.path.abspath(os.path.dirname(__file__))
83+
with open(os.path.join(this_directory, "README.rst"), encoding="utf-8") as f:
84+
long_description = f.read()
8385
exec(open("redshift_connector/version.py").read())
8486

8587
setup(
8688
name="redshift_connector",
8789
version=__version__,
8890
description="Redshift interface library",
8991
long_description=long_description,
92+
long_description_content_type="text/markdown",
9093
author="Amazon Web Services",
9194
author_email="[email protected]",
9295
url="https://github.com/aws/amazon-redshift-python-driver",

0 commit comments

Comments
 (0)