github上Python包的自述文件的格式是什么?

时间:2014-08-21 13:53:17

标签: python github package packaging

distutils中的Python setup.py在包的根目录中查找READMEREADME.txt。 github识别README.mdREADME.rst等格式。如何编写一个满足两者的格式化根级README文件?

我在这里看到的唯一建议是运行Pandoc以在格式之间进行转换。如果可能的话,我想避免添加额外的构建步骤。

有没有办法告诉distutils"使用我的README.rst"?

或者,当我运行python setup.py sdist时,忽略此警告是否有任何不良后果?

warning: sdist: standard file not found: should have one of README, README.txt

PS。我使用distutils.core,因为Google引导我here。那已经过时了吗?

1 个答案:

答案 0 :(得分:1)

看起来答案是使用setuptools代替distutils.core。如果您按照setuptools instructions进行操作,则可以看到如何将默认README作为.rst文件。