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

Use README.md in setup.py -> long_description #72

Open
senpos opened this issue Jul 11, 2018 · 1 comment
Open

Use README.md in setup.py -> long_description #72

senpos opened this issue Jul 11, 2018 · 1 comment

Comments

@senpos
Copy link
Contributor

senpos commented Jul 11, 2018

Isn't it a good idea to get rid of long_description and just load it from README.md, as described in the official packaging tutorial?

It should be easier to make changes, since you will have to change only one file, rather than two. As I can see, both of them are (almost) identical.

with open("README.md", "r") as fh:
    long_description = fh.read()

setuptools.setup(
    ...
    long_description=long_description,
    long_description_content_type="text/markdown",
    ...

That's all we need to change, I believe.

I can make a PR for this.

@joshuaskelly
Copy link
Owner

As long as things look fine on PyPi, I'm fine with this. Send a PR! 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants