Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make readme readable on pypi #24

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 3 additions & 6 deletions setup.py
@@ -1,13 +1,9 @@
import re
from setuptools import setup

description = 'Version-bump your software with a single command!'

long_description = re.sub(
"\`(.*)\<#.*\>\`\_",
r"\1",
str(open('README.md', 'rb').read()).replace(description, '')
)
with open('README.md', 'UTF-8') as readme:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This breaks on Python 3 with ValueError: invalid mode: 'UTF-8', see the Travis run.

long_description = readme.read()

setup(
name='bump2version',
Expand All @@ -19,6 +15,7 @@
packages=['bumpversion'],
description=description,
long_description=long_description,
long_description_content_type="text/markdown",
entry_points={
'console_scripts': [
'bumpversion = bumpversion:main',
Expand Down