如何为PyPI软件包添加变更日志(changelog)链接?
给PyPI项目添加变更日志链接的方法
有两种常用方式可以给你的PyPI项目添加变更日志链接,配置后重新上传项目就能在PyPI页面侧边栏显示:
方式一:用setup.py配置
在项目的setup.py文件里,通过project_urls参数指定变更日志的地址,示例代码如下:
from setuptools import setup setup( name="你的项目名称", # 这里填其他必要配置(版本号、作者等) project_urls={ "Changelog": "https://你的项目地址/CHANGELOG.md", # 还可以添加其他链接,比如源码仓库、文档页等 }, )
方式二:用pyproject.toml配置(推荐)
如果你的项目采用PEP 621标准,用pyproject.toml管理配置,直接在文件里添加[project.urls]区块:
[project] name = "你的项目名称" # 其他项目配置... [project.urls] "Changelog" = "https://你的项目地址/CHANGELOG.md" "Homepage" = "https://你的项目主页地址"
注意点
- 链接可以指向项目仓库里的CHANGELOG.md文件,也可以是单独的变更日志网页
- 确保链接地址有效,PyPI会直接展示你设置的链接文本和地址
- 配置完成后,重新构建并上传项目到PyPI,新的项目页面就会显示变更日志链接了
内容的提问来源于stack exchange,提问作者Flimm
相关产品推荐
相关产品推荐

