Readme on Github and PyPi

Question

I have my python library on pypi and github. There's only one README file in it which is README.md and it's displayed properly on github. But on pypi it doesn't, it's shown as a plain text. How come and what can I do about it?

Preferably without involving a third-party libraries such as Pandoc.

I don't think you can do it without third-party conversion. See this discussion. — BrenBarn
– BrenBarn, Commented Mar 22, 2015 at 5:28

tacaswell · Accepted Answer · 2015-03-22 05:31:31Z

2

Please refer to this posting.

To quote the relevant section:

Every package on PyPI needs to have a file called setup.py at the root of the directory. If your'e using a markdown-formatted read me file you'll also need a setup.cfg file.

setup.cfg

This tells PyPI where your README file is.

[metadata]

description-file = README.md

This is necessary if you're using a markdown readme file. At upload time, you may still get some errors about the lack of a readme — don't worry about it. If you don't have to use a markdown README file, I would recommend using reStructuredText (REST) instead.

answered Mar 22, 2015 at 5:31

tacaswell

88.2k23 gold badges222 silver badges203 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

tacaswell Over a year ago

Then I have nothing for you. You should update your question to include those details.

Collectives™ on Stack Overflow

Readme on Github and PyPi

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related