Use setup.cfg for long_description #85
Open
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
OrangeTux
reviewed
Feb 5, 2020
| @@ -7,17 +7,12 @@ | |||
| import os | |||
| from setuptools import setup | |||
|
|
|||
| cwd = os.path.dirname(os.path.abspath(__name__)) | |||
|
|
|||
| long_description = open(os.path.join(cwd, 'README.rst'), 'r').read() | |||
There was a problem hiding this comment.
I was wondering, is the problem also fixed if you open the file using utf-8 encoding? like
long_description = open(os.path.join(cwd, 'README.rst'), 'r', encoding='utf-8').read()
There was a problem hiding this comment.
I was not sure you are willing to keep compatibility with python2, so I suggested the way using setup.cfg that will also work with python2. If you are not willing, of course the way using encoding='utf-8' is also possible.
There was a problem hiding this comment.
I like that you thought about backward compatibility. But we just decided to drop Python 2 support, see #86 . So we can use the encoding argument of open().
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.
Fixes #84.
It seems setuptools can determine an encoding of a file if I write like
long_description = file: README.rstin setup.cfg.