返回

如何从私有 GitHub 仓库使用 pip 安装 Python 软件包?

python

从私有 GitHub 仓库使用 pip 安装软件包

引言

在 Python 开发中,我们经常需要从 GitHub 仓库安装软件包。如果该仓库是私有的,则需要采取特殊的方法才能使用 pip 进行安装。本博客文章将指导你如何从私有 GitHub 仓库安装 Python 软件包,并介绍使用 SSH 和 HTTPS 协议的两种方法。

生成个人访问令牌

要从私有仓库安装软件包,我们需要使用个人访问令牌。这是一个安全的令牌,可以让我们访问仓库而不暴露我们的密码。登录 GitHub 帐户,导航到“设置”>“开发者设置”>“个人访问令牌”,然后生成一个新令牌。务必复制令牌并将其保存在安全的地方,因为以后需要使用。

使用 SSH 协议

SSH 协议是一种安全的协议,用于通过命令行连接到远程服务器。要使用 SSH 协议安装软件包,可以使用以下命令:

pip install git+ssh://git@github.com/echweb/echweb-utils.git#egg=echweb-utils&extra-index-url=https://pypi.org/simple/

在这个命令中:

  • git+ssh 指定使用 SSH 协议克隆仓库。
  • git@github.com 是 GitHub 服务器的地址。
  • echweb/echweb-utils.git 是要克隆的仓库。
  • egg=echweb-utils 指定要安装的软件包名称。
  • extra-index-url 指定了公共 PyPI 索引,以确保可以安装任何依赖项。

使用 HTTPS 协议

如果无法使用 SSH 协议,可以使用 HTTPS 协议。但是,我们需要将个人访问令牌添加到 Git 配置中:

git config --global http.https://github.com/.extraHeader "Authorization: Bearer <your-personal-access-token>"

然后可以使用以下命令进行 pip 安装:

pip install git+https://github.com/echweb/echweb-utils.git#egg=echweb-utils&extra-index-url=https://pypi.org/simple/

验证安装

安装完成后,可以使用 pip list 命令验证软件包是否已成功安装。

结论

通过遵循本文中的步骤,你可以轻松地从私有 GitHub 仓库安装 Python 软件包。无论使用 SSH 还是 HTTPS 协议,都可以在开发过程中节省时间和精力。

常见问题解答

  • 我无法生成个人访问令牌怎么办?

你需要拥有仓库的管理权限才能生成个人访问令牌。

  • 我添加个人访问令牌后仍然无法安装软件包怎么办?

检查 Git 配置是否正确,并确保已为仓库启用了 SSH 密钥。

  • 我可以使用此方法安装依赖项吗?

是的,extra-index-url 参数允许你指定公共 PyPI 索引以安装依赖项。

  • 我需要多久更新一次个人访问令牌?

最好每隔几个月更新一次个人访问令牌,以提高安全性。

  • 是否有其他方法可以从私有仓库安装软件包?

其他方法包括使用 GitHub 的发布功能或使用第三方包管理器,如 Twine 或 PyPI。