switch to markdown README exclusively

clld · May 16, 2018 · 122990b · 122990b
1 parent f5c075c
commit 122990b
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 42 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,2 +1,3 @@
+include README.md
 graft src
 global-exclude *.py[co]
diff --git a/README.rst b/README.rst
diff --git a/RELEASING.md b/RELEASING.md
@@ -60,17 +60,18 @@ git commit -a -m "release <VERSION>"
 git tag -a v<VERSION> -m "<VERSION> release"
 ```
 
-- Release to PyPI:
+- Release to PyPI (see https://github.com/di/markdown-description-example/issues/1#issuecomment-374474296):
 ```shell
-git checkout tags/v<VERSION>
 rm dist/*
-python setup.py sdist bdist_wheel
+python setup.py sdist
+twine upload dist/*
+rm dist/*
+python setup.py bdist_wheel
 twine upload dist/*
 ```
 
 - Push to github:
 ```shell
-git checkout master
 git push origin
 git push --tags origin
 ```

diff --git a/setup.py b/setup.py
@@ -1,14 +1,5 @@
-import os
-
 from setuptools import setup, find_packages
 
-
-try:
-    README = open(
-        os.path.join(os.path.abspath(os.path.dirname(__file__)), 'README.rst')).read()
-except IOError:
-    README = ''
-
 install_requires = [
     'Babel',
     'csvw~=1.0',
@@ -45,7 +36,8 @@
     version='4.2.2.dev0',
     description=(
         'Python library supporting the development of cross-linguistic databases'),
-    long_description=README,
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
     classifiers=[
         "Intended Audience :: Developers",
         "License :: OSI Approved :: Apache Software License",