如何让 setuptools 安装不在 PyPI 上的包？

Question

我刚刚开始使用 setuptools 和 virtualenv。我的包需要最新的 python-gearman，只能从 GitHub 获得。 PyPI 上的 python-gearman 版本是旧版本。 Github 源码与 setuptools 兼容，即有 setup.py 等。有没有办法让 setuptools 下载并安装新版本，而不是在 PyPI 上查找并安装旧版本？

仅供参考，新的 python-gearman 是 http://github.com/mtai/python-gearman

Answer 1

因为我只需要做同样的事情，我找到了另一种方法来做到这一点，因为 pip 的 --process-dependency-links 计划在 pip 19.0 中根据 this comment 删除。

pip18.1 包含以下功能

允许将 PEP 508 URL 要求用作依赖项。

根据 PEP 508 的 the description，此类 URL 依赖项的语法如下：

基于 URL 的最小查找：

点子@https://github.com/pypa/pip/archive/1.3.1.zip#sha1=da9234ee9982d4bbb3c72346a6de940a148ea686

所以在你的setup.py 中看起来像

setup(
   ...
   install_requires = [
   ...
   'python-gearman @ https://github.com/mtai/python-gearman/archive/master.zip'
   ...
   ]
)

请注意，该链接是一个存档文件，也可以是存储库的特定版本或分支，如 in this answer 所述。此外，请参阅与其他存储库主机合作的答案。

据我所知，更新依赖项的最简单方法是在从其目录安装包时使用pip install -I .。

Answer 2

关键是告诉easy_install包可以下载到哪里。在这种特殊情况下，可以在 URL http://github.com/mtai/python-gearman/tarball/master 中找到它。但是，该链接本身不起作用，因为 easy_install 不能仅通过查看 URL 来判断它将获得什么。

改为http://github.com/mtai/python-gearman/tarball/master#egg=gearman-2.0.0beta，easy_install 将能够识别软件包名称及其版本。

最后一步是将URL添加到你的包的dependency_links，例如：

setup(
   ...
   dependency_links = ['http://github.com/mtai/python-gearman/tarball/master#egg=gearman-2.0.0beta']
)

现在，当您的软件包被安装时，easy_install 会发现有一个“gearman 2.0.0beta”可供从该 URL 下载，如果您指定“gearman>=2.0”，那么会很高兴地在 PyPI 上选择它而不是那个.0beta" 在您的依赖项中..

（通常，这种事情的完成方式是在一个人的 PyPI 页面上包含一个指向可下载源的链接；在这种情况下，如果 gearman 包的作者包含了类似上面的链接，你会已经设置了。通常，人们用'myproject-dev'标记开发版本，然后人们使用'myproject>=somever，==dev'的要求，这样如果没有somever或更高的包，easy_install将尝试签出或下载该版本。）

在使用pip 时，您需要指定--process-dependency-links。请注意，依赖链接处理已被弃用，并将在未来的版本中删除。

Answer 3

您可以使用pip install protocol+location[@tag][#egg=Dependency] 格式通过 pip 直接从源安装。

Git

pip install git+https://github.com/username/repo.git
pip install git+https://github.com/username/repo.git@MyTag
pip install git+https://github.com/username/repo.git@MyTag#egg=ProjectName

水银

pip install hg+https://hg.myproject.org/MyProject/

SVN

pip install svn+svn://svn.myproject.org/svn/MyProject

Bzr

pip install bzr+http://bzr.myproject.org/MyProject/trunk

支持以下协议：[+git, +svn, +hg, +bzr]

版本

@tag 允许您指定要签出的特定版本/标签。

#egg=name 让您可以指定项目是什么作为其他人的依赖项。

订单必须始终为@tag#egg=name。

私人仓库

您还可以通过将协议更改为 SSH (ssh://) 并添加适当的用户 (git@) 从私有存储库进行安装：

git+ssh://git@github.com/username/my_private_repo

您也可以使用用户名/密码从私有存储库安装。

git+https://<username>:<password>@github.com/<user>/<repo>.git

Github 提供了创建personal OAuth tokens 的功能，可以循环使用

git+https://<oauth token>:x-oauth-basic@github.com/<user>/<repo>.git

requirements.txt

requirements.txt用于指定项目依赖：

requirements.txt

package1
package2==1.0.2
package3>=0.0.4
git+https://github.com/username/repo.git

这些不会随软件包自动安装，必须使用命令pip -r requirements.txt 安装。

包括需求文件

需求文件可以包含其他需求文件：

requirements-docs.txt

sphinx
-r requirements-dev.txt

requirements-dev.txt

some-dev-tool
-r requirements.txt

requirements.txt

package1
package2==1.0.2
package3>=0.0.4
git+https://github.com/username/repo.git

setup.py

需求文件可以使用以下命令安装setup.py中指定的依赖项：

-e .

setup.py 也可以使用与上述相同的语法从存储库安装，但使用this answer 中提到的dependency_links 值。

参考资料：

https://pip.pypa.io/en/latest/user_guide.html#installing-packages https://pip.pypa.io/en/latest/reference/pip_install.html

Answer 4

Vanilla setuptools 不支持直接从 git 存储库下载，但您可以使用该页面的 Download Source 链接之一，例如：

easy_install http://github.com/mtai/python-gearman/tarball/master