如何将图像添加到 PyPI 自述文件（可在 GitHub 上运行）？

Posted 2023-02-24

【中文标题】如何将图像添加到 PyPI 自述文件（可在 GitHub 上运行）？

【英文标题】：How do I add images to a PyPI readme (that works on GitHub)?

【发布时间】：2017-06-18 09:39:34

【问题描述】：

在我在 GitHub 上的自述文件中，我的项目源代码树中有几张图片，我使用类似指令成功引用了这些图片

.. image:: ./doc/source/_static/figs/moon_probe.png

我还希望在 PyPi 中生成相同的自述文件时显示这些图像。

我如何 (a) 确保图像存在于 PyPi 上以供自述文件访问，以及 (b) 制定 .. image:: 指令来访问它们？

【参考方案1】：

PyPI 不会读取图像的包分发。您必须使用图片的外部链接，例如：

.. image:: https://raw.githubusercontent.com/greyli/flask-share/master/images/demo.png

如果你使用 Markdown 描述，使用这个：

![](https://raw.githubusercontent.com/greyli/flask-share/master/images/demo.png)

请务必将以上示例中的 URL 替换为您的图片 URL，这里我使用的是 GitHub 托管的图片，实际演示在 PyPI。

附：要在 GitHub 上获取图片的原始链接，请右键单击图片并选择复制图片地址。

【讨论】：

不起作用，需要一个现在过期的令牌。我见过一两个仍然有效，但它们似乎是降价而不是 RST。

这是唯一对我有用的东西。在 Markdown 中，链接如下所示：![](https://raw.githubusercontent.com/username/project/branch/image.png)

@MikeConigliaro 使用![](...) 而不是![alt text](...) 重要吗？后者只是为我在 PyPi 上显示 alt 文本。

这也适用于 GIF 吗？它们是否显示在 PyPi 上？

@CGFoX 我不确定，但这是我使用它的地方：pypi.org/project/smtptester

【参考方案2】：

转到 Github 存储库中的图像地址。显示的路径将如下所示： https://github.com/tensorbored/kds/blob/master/docs/_static/readme_lift.png 将图片地址中的 blob 术语更改为 raw https://github.com/tensorbored/kds/raw/master/docs/_static/readme_lift.png

【参考方案3】：

如果您在 Github 上有图片，请导航到该图片，然后右键单击下载按钮并复制链接地址：

然后您可以将其添加到您的 README.md 文件中：

![](https://github.com/your_username/your_repository/raw/master/images/img2.png)

它应该在 Github 和 PyPi 上都能正确呈现。

【参考方案4】：

在 GitHub 图片链接末尾设置 ?raw=True 似乎有效。

示例：

![Sample image](https://github.com/usename/reponame/blob/master/sample.png?raw=True)

_{我之前在互联网的某个地方找到了这个，但现在找不到了。当我再次找到它时，我会感谢原作者。}