Skip to content

项目元数据

Python 包可以包含额外的元数据，以提供更多关于项目的信息。本文档概述了 PyPI 为显示项目元数据和其他详细信息而实现的具体行为。完整的元数据字段列表可在《Python 打包用户指南》中找到。

项目网址

软件包所有者可以使用软件包中的[project.urls]表格指定与其项目相关的各种 URL pyproject.toml。

PyPI 会在项目页面上渲染这些 URL，并将它们拆分成verified子 unverified组。它们也可以通过JSON API获取。

已核实详情

已核实详情

PyPI 目前支持多种验证项目 URL 的方法。当 URL 验证通过后，PyPI 会用绿色对勾 ( ) 将其突出显示。

警告

经过验证的 URL 仅证明该 URL 在验证时处于 PyPI 包所有者的控制之下，并不意味着该 URL 具有任何额外的安全性，也不意味着与相关项目存在任何其他关系。

URL验证在发布文件上传时进行，之后不会重复进行。这意味着已验证URL指向的网站可能会发生变化，但URL仍会显示为已验证状态。已验证状态仅反映文件上传时URL的控制权，不代表之后的任何状态。

以下各小节详细说明了可以验证的不同类型的 URL。

PyPI 会将指向 PyPI 上该项目的任何 URL 视为已验证。例如，项目页面pip会将以下所有内容标记为已验证：

  • https://pypi.org/project/pip/
  • https://pypi.org/p/pip/
  • https://pypi.python.org/project/pip
  • https://pypi.python.org/p/pip
  • https://python.org/pypi/pip

通过 Trusted Publishing

Trusted Publishing允许 PyPI 证明软件包的发布工作流程来自经过验证的来源。

可验证的 URL 取决于所使用的可信发布者：

  • GitHub Actions：使用 GHA 从仓库上传的软件包将验证该仓库的 GitHub URL。例如，对于以下pypa/pip仓库，将验证以下 URL：
    • https://github.com/pypa/pip
    • https://github.com/pypa/pip/*（所有子路径）
    • https://github.com/pypa/pip.git
    • https://pypa.github.io/pip
    • https://pypa.github.io/pip/*（所有子路径）
  • GitLab CI/CD：使用 GitLab CI/CD 从代码仓库上传的软件包，其对应的 GitLab URL 将被验证。例如，对于以下代码仓库pypa/pip，将验证以下 URL：
    • https://gitlab.com/pypa/pip
    • https://gitlab.com/pypa/pip/*（所有子路径）
    • https://gitlab.com/pypa/pip.git
  • Google Cloud：目前没有经过验证的 Google 特定网址。
  • ActiveState：使用 ActiveState 上传的软件包的 URL 将链接到 ActiveState 中已验证的项目：
    • https://platform.activestate.com/pypa/pip
    • https://platform.activestate.com/pypa/pip/*（所有子路径）

图标

未经核实的信息

虽然标签或 URL 可以是任意的，但 PyPI 会识别以下列表中的标签或 URL，并将默认图标更改为 自定义图标。

通用网址

要显示自定义图标，条目必须符合指定的模式之一。识别模式不区分大小写。标有星号 ( * ) 的条目表示前缀。这意味着任何以指定模式开头的名称都将被识别。

姓名 图标 描述 别名
首页 项目主页
下载 下载链接
更新日志 变更日志信息 变更日志、变更、新闻、新增内容、最新动态、历史记录
发布说明 精选发布信息 发布说明
文档* 项目文档 Docs *，指向Read the Docsdocs.域名的 URL 或以或开头的 URL 。documentation.
漏洞* 错误/问题报告位置 问题*、跟踪器*、报告*
资金* 赞助信息 赞助*，捐赠*，捐款*
安全 安全策略或漏洞报告页面 安全策略，安全策略
来源 源代码库 源代码、源代码库

托管平台

要显示自定义图标，条目 URL 必须指向下方列出的域名。自定义子域名也会被匹配。例如，如果domain.com列出了 `<example.com>`，则以 `<example.com>` 结尾的 URL.domain.com也会匹配。

服务 图标 领域
Bitbucket bitbucket.org
科德伯格 codeberg.org，codeberg.page
GitHub github.com，github.io
GitLab gitlab.com
谷歌 google.com

社交媒体平台

要显示自定义图标，条目必须满足以下条件之一：

  • 使其名称与列出的不区分大小写的模式匹配
  • 指向已列出域名的 URL（支持自定义子域名）
平台 图标 姓名 领域
Discord discord.com，，discordapp.com​discord.gg
电报 t.me，，telegram.me​telegram.dog
矩阵 matrix.to
吉特 gitter.im
乳齿象 乳齿象
Reddit reddit.com
松弛 Slack * slack.com
YouTube youtube.com，youtu.be
叽叽喳喳 twitter.com，x.com
蓝天 蓝天 bsky.app

持续集成服务

要显示自定义图标（），条目 URL 必须指向下面列出的服务提供商域名之一。支持自定义子域名。

服务 领域
AppVeyor ci.appveyor.com
CircleCI circleci.com
Codecov codecov.io
连体工作服 coveralls.io
特拉维斯CI travis-ci.com，travis-ci.org

Python 生态系统

要显示自定义图标，条目 URL 必须指向下面列出的域名之一。

姓名 图标 领域
PyPI cheeseshop.python.org，，，pypi.io​pypi.org​pypi.python.org
Python python.org，*.python.org