在Pypi上传中为markdown README指定Description-Content-Type

时间:2017-08-04 08:34:29

标签: python markdown pypi

根据PyPA Specifications,上传到Pypi时应该可以使用markdown格式化的README文件。

我不太了解的是放置此配置行的位置。我怀疑它必须是PKG-INFO但是a)它不起作用(我在setup.py dist之后手动添加)和b)我不认为它是打算添加的手动

我还做的是在Manifest.in

中添加README.md
include README.md

并在setup.cfg中指定它:

[metadata]
description-file = README.md

您可以查看我的回购here

但是,pypi上没有显示任何内容,就好像没有自述文件一样。

我完全清楚RST是推荐的方式,网上的大多数内容都是关于如何将MD转换为RST,这对我来说既不适用(可能是由于RST版本不兼容)。根据{{​​3}}并提到this blog post,应该可以使用markdown,我非常希望这样做。

1 个答案:

答案 0 :(得分:0)

description-content-type = text/markdown; charset=UTF-8

Hereprb中对此配置属性的非常简短的描述:

  

您可以将description-content-type设置为MIME类型,以帮助呈现描述;例如 text / markdown 或text / x-rst; charset = UTF-8。