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.

Sign up for GitHub

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

Jump to bottom

Connect README with setup.py so it shows up on PyPI #42

Open
palewire opened this issue Aug 6, 2019 · 2 comments
Open

Connect README with setup.py so it shows up on PyPI #42

palewire opened this issue Aug 6, 2019 · 2 comments

Comments

@palewire
Copy link
Contributor

palewire commented Aug 6, 2019

No description provided.

@ghing
Copy link
Contributor

ghing commented Dec 23, 2020

I just came across this issue, and I believe that Markdown is now supported by PyPI's README renderer.

Source: Making a PyPI-friendly README — Python Packaging User Guide

@palewire
Copy link
Contributor Author

A good point! I'll revise the ticket.

@palewire palewire changed the title Convert README to ReST for PyPI Connect README with setup.py so it shows up on PyPI Dec 23, 2020
ghing added a commit to ghing/census-data-downloader that referenced this issue Dec 23, 2020
@ghing
Add README as long description
2fb2c62 
Read the contents of `README.md` and set as the `long_description` argument to `setup()`. This allows displaying the README contents in PyPI. The pattern for doing this is from [Making a PyPI-friendly README](https://packaging.python.org/guides/making-a-pypi-friendly-readme/).

Addresses datadesk#42
@ghing ghing mentioned this issue Dec 23, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@palewire @ghing