Fixes #31: Migrate setup.py long_description to markdown README for p…

…ypi (#103)
manrajgrover · Nov 2, 2018 · 695f8f8 · 695f8f8
2 parents f047545 + 6dfb3be
commit 695f8f8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -2,3 +2,4 @@ coverage==4.4.1
 nose==1.3.7
 pylint==1.7.2
 tox==2.8.2
+twine==1.12.1
diff --git a/setup.py b/setup.py
@@ -6,13 +6,17 @@ def dependencies(file):
         return f.read().splitlines()
 
 
+with open("README.md") as infile:
+    long_description = infile.read()
+
 setup(
     name='halo',
     packages=find_packages(exclude=('tests', 'examples')),
     version='0.0.18',
     license='MIT',
     description='Beautiful terminal spinners in Python',
-    long_description='Beautiful terminal spinners in Python. Find the documentation here: https://github.com/ManrajGrover/halo',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     author='Manraj Singh',
     author_email='manrajsinghgrover@gmail.com',
     url='https://github.com/manrajgrover/halo',