Read README as utf-8 text and set the content_type to text/markdown #26
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ekohl
previously requested changes
Aug 1, 2018
setup.py
Outdated
| try: | ||
| with open(os.path.join(here, 'README.md'), encoding='utf-8') as f: | ||
| long_description = '\n' + f.read() | ||
| except FileNotFoundError: |
There was a problem hiding this comment.
This exception was introduced in Python 3.something. Sadly it doesn't work on py2.
ekohl
reviewed
Aug 1, 2018
setup.py
Outdated
| try: | ||
| with open(os.path.join(here, 'README.md'), encoding='utf-8') as f: | ||
| long_description = '\n' + f.read() | ||
| except IOError: |
There was a problem hiding this comment.
I'm actually not sure we should be catching that exception. It should always exist and otherwise it's an error.
setup.py
Outdated
| here = os.path.abspath(os.path.dirname(__file__)) | ||
| try: | ||
| with open(os.path.join(here, 'README.md'), encoding='utf-8') as f: | ||
| long_description = '\n' + f.read() |
There was a problem hiding this comment.
It just looks nicer in the *.dist-info/METADATA file in the wheel package.
ekohl
reviewed
Aug 1, 2018
setup.py
Outdated
| # Import the README and use it as the long-description. | ||
| # This requires 'README.md' to be present in MANIFEST.in. | ||
| here = os.path.abspath(os.path.dirname(__file__)) | ||
| with open(os.path.join(here, 'README.md'), encoding='utf-8') as f: |
There was a problem hiding this comment.
encoding is not a valid parameter on python 2. It's better to use io.open which should already be present on python 2.7.
|
Could you rebase on master and see if it fixes the tests on travis with 3.4? |
This requires an up-to-date setuptools; older versions will complain about it (without crashing).
florisla
force-pushed
the
readable-readme
branch
from
7b69465
to
cc00ff2
Compare
|
No luck with AppVeyor or Travis... any suggestions? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an improvement on #24 and fixes #17.
The generated wheel file contains the correct content_type and 'README' content.