Skip to content

Commit 23b4142

Browse files
authored
project description in pypi docs (#1172)
Add long description into setuptools so that it will be added in pypi description.
1 parent 6b7f9a6 commit 23b4142

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

setup.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
mod_dir = os.path.join(work_dir, 'src', 'confluent_kafka')
1010
ext_dir = os.path.join(mod_dir, 'src')
1111

12+
with open(os.path.join(work_dir, 'README.md'), encoding='utf-8') as f:
13+
long_description = f.read()
14+
1215
INSTALL_REQUIRES = [
1316
'futures;python_version<"3.2"',
1417
'enum34;python_version<"3.4"',
@@ -80,6 +83,8 @@ def get_install_requirements(path):
8083
description='Confluent\'s Python client for Apache Kafka',
8184
author='Confluent Inc',
8285
author_email='[email protected]',
86+
long_description=long_description,
87+
long_description_content_type='text/markdown',
8388
url='https://github.com/confluentinc/confluent-kafka-python',
8489
ext_modules=[module],
8590
packages=find_packages('src'),

0 commit comments

Comments
 (0)