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 setup.cfg to use README.md for PyPI description #7

Closed
dhimmel opened this issue Feb 15, 2017 · 2 comments
Closed

Use setup.cfg to use README.md for PyPI description #7

dhimmel opened this issue Feb 15, 2017 · 2 comments

Comments

@dhimmel
Copy link
Member

@dhimmel dhimmel commented Feb 15, 2017

Currently, we have to use README.rst for the long_description in setuptools to created the description for PyPI.

Accoridng to this tutorial, we may be able to create a setup.cfg file containing:

[metadata]
description-file = README.md

That would be awesome. This rst format and duplicating the README has been a real annoyance. Will wait on the merging of #6, so this doesn't cause any conflicts.

@dhimmel

This comment has been minimized.

Copy link
Member Author

@dhimmel dhimmel commented Mar 2, 2017

Just tried the method from the tutorial and no long description showed up on test PyPI.

Therefore, It seems like there is no easy way to use a markdown README for PyPI. Solutions involve requiring pandoc locally, which is a heavy dependency.

I think the best thing to do is just make the rst README for both GitHub and PyPI long_description. What an annoyance!

@dhimmel dhimmel closed this in 0faba34 Mar 2, 2017
dhimmel added a commit that referenced this issue Mar 2, 2017
Closes #7
@dhimmel

This comment has been minimized.

Copy link
Member Author

@dhimmel dhimmel commented Mar 2, 2017

See 8f74660. I ended up using pandoc via a subprocess call.

I think this is a decent workaround. If pandoc isn't installed, then long_description is None. This would only matter for the installation that is getting uploaded to PyPI. I added a pandoc dependency on Travis, so if we switch to Travis deployment, then we should be all good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.