在 PyPi 中创建 Python 包时，如何指定自述文件的路径答案

【问题标题】：When creating a Python package in PyPi how do I specify a path for the readme file在 PyPi 中创建 Python 包时，如何指定自述文件的路径
【发布时间】：2021-10-30 13:58:00
【问题描述】：

创建 Python 包时，我在 setup.cfg 中的“long_description”标题下设置了自述文件的文件名：

long_description = file: README.md

这假定 README.md 文件位于项目的根目录中。如何指定替代位置？我尝试过失败：

long_description = file: Docs/README.md

【问题讨论】：

为什么不在最外层的目录中有你的 README？这就是人们在打开你的包时所期望的——如果你想拥有一个更深入的文档系统，你甚至可以将它们引用到 Docs 目录

标签： python-3.x pypi

【解决方案1】：

我建议你试试：

long_description = open('your file').read()

【讨论】：

我认为如果我使用的是 setup.py 文件，您的答案可能会起作用，但我使用的是 setup.cfg。无论如何，我在 setup.cfg 文件中尝试过，但没有成功。

【解决方案2】：

我需要通过在我的基本目录中创建一个 MANIFEST.in 文件，并使用一个定位我的自述文件的指令来明确包含我的自述文件的路径：

include Docs/README.md

MANIFEST.in 文件和相关指令的详细信息在https://packaging.python.org/guides/using-manifest-in/#using-manifest-in 路径仍需位于setup.cfg 文件中的 long_description 标题下

【讨论】：