search

joshuaskelly / twitch-observer

Turn Twitch chatter into Python events
MIT License
26 stars 6 forks source link

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

Open senpos opened 6 years ago

senpos commented 6 years ago

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 commented 6 years ago

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