LoginSignup
2
2

More than 5 years have passed since last update.

How to manage a README for both github and PyPI

Last updated at Posted at 2012-07-29

First of all, write a README in either Markdown (.md) or ReStructuredText (.rst). Next, convert the README to the other one with pandoc.

pandoc -f markdown -t rst README.md > README

or

pandoc -f rst -t markdown README > README.md

Note that PyPI requires not README.rst but README.

For PyPI, you need to set the README content to long_description in setup.py:

setup(
    ...
    long_description=open('README').read(),
    ...

Then, your PyPI page looks same as github page.

2
2
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
2