Convert README to PyPI description?

edsu / pymarc

process MARC records from Python

http://python.org/pypi/pymarc

Other

253 stars 98 forks source link

Closed katrinleinweber closed 6 years ago

katrinleinweber commented 6 years ago

https://pypi.org/project/pymarc/#description says: The author of this package has not provided a project description. Can this be prevented by displaying README.md's content there? Or some of it? Maybe even in a PyPI-standard way?

edsu commented 6 years ago

Ok! I was doing this recently for another project.

edsu commented 6 years ago

Does this look better?

edsu commented 6 years ago

Just in case you are curious...

The trick I learned over here from @hugovk is to pull the markdown in as long_description and set long_description_content_type="text/markdown".

Then it's necessary to use twine to do the upload to PyPI instead of python setup.py upload.

% python setup.py sdist
% twine upload dist/*