twitch-observer icon indicating copy to clipboard operation
twitch-observer copied to clipboard

Use README.md in setup.py -> long_description

Open senpos opened this issue 6 years ago • 1 comments

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.

senpos avatar Jul 11 '18 07:07 senpos

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

joshuaskelly avatar Jul 11 '18 17:07 joshuaskelly