project description in pypi docs (confluentinc#1172)

Bowrna · web-flow · commit 23b4142a3b1f · 2021-08-03T12:01:50.000-07:00
Add long description into setuptools so that it will be added in pypi
description.
diff --git a/setup.py b/setup.py
@@ -9,6 +9,9 @@
 mod_dir = os.path.join(work_dir, 'src', 'confluent_kafka')
 ext_dir = os.path.join(mod_dir, 'src')
 
+with open(os.path.join(work_dir, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
 INSTALL_REQUIRES = [
     'futures;python_version<"3.2"',
     'enum34;python_version<"3.4"',
@@ -80,6 +83,8 @@ def get_install_requirements(path):
       description='Confluent\'s Python client for Apache Kafka',
       author='Confluent Inc',
       author_email='support@confluent.io',
+      long_description=long_description,
+      long_description_content_type='text/markdown',
       url='https://github.com/confluentinc/confluent-kafka-python',
       ext_modules=[module],
       packages=find_packages('src'),
