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

Posted 2023-02-24

【中文标题】在 Pypi 上传中为 markdown README 指定 Description-Content-Type

【英文标题】：Specify Description-Content-Type in Pypi upload for markdown README

【发布时间】：2018-01-12 02:34:35

【问题描述】：

根据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

你可以看看我的 repo here。

但是，pypi 上什么也没有显示，好像没有 README。

我完全知道 RST 是推荐的方式，网络上的大多数内容都是关于如何将 MD 转换为 RST，这对我也不起作用（可能是由于 RST 版本不兼容）。根据this blog post 和提到的PyPA Specifications 应该可以使用降价，我非常想这样做。

【问题讨论】：

这怎么行？你期待什么没有得到？

请注意，PyPA 规范仅适用于新的 pypi.org，不适用于旧的 pypi.python.org。请参阅Migrating to PyPI.org 了解更多信息。据我了解，遗留系统从来没有，也永远不会支持 Markdown。

离题，但仅供参考，查看 pypi.python.org/pypi/html2kirby/0.1 我注意到您在开头的通用链接 Kirbytext 而是链接到页面内的 #links 片段：getkirby.com/docs/content/text#links

我已经修复了我的答案，现在已经过测试并且可以正常工作了

【参考方案1】：

简介：（固定）

long-description-content-type = text/markdown

更新

prb 描述不正确

签出我的项目作为参考。在test.pypi 和github 上的来源。