github 上 Python 包的 README 格式是啥？

Posted 2023-02-24

【中文标题】github 上 Python 包的 README 格式是啥？

【英文标题】：What format for a Python package's README on github?github 上 Python 包的 README 格式是什么？

【发布时间】：2014-10-15 04:41:10

【问题描述】：

setup.py 中的 Python distutils 在包的根目录中查找 README 和 README.txt。 github 可以识别README.md 和README.rst 等格式。如何编写一个格式化的根级 README 文件同时满足两者？

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

有没有办法告诉distutils“使用我的README.rst”？

另外，当我运行python setup.py sdist 时忽略此警告是否会产生任何不良影响？

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

附言。我正在使用distutils.core，因为谷歌引导我here。是不是已经过时了？

【问题讨论】：

ln -s README.md README ?由于降价来源是“人类友好的”，这可能就足够了......

【参考方案1】：

看起来答案是使用setuptools 而不是distutils.core。如果您关注setuptools instructions，您可以了解如何将您的默认 README 设置为 .rst 文件。