如何在requirements.txt中声明一个直接的github源代码

Question

我已经使用该命令安装了一个库

pip install git+git://github.com/mozilla/elasticutils.git

它直接从Github存储库安装它.这工作正常,我希望在我的requirements.txt.我看其他的票像这样但这并没有解决我的问题.如果我把类似的东西

-f git+git://github.com/mozilla/elasticutils.git
elasticutils==0.7.dev

在requirements.txt文件中,pip install -r requirements.txt结果如下:

Downloading/unpacking elasticutils==0.7.dev (from -r requirements.txt (line 20))
  Could not find a version that satisfies the requirement elasticutils==0.7.dev (from -r requirements.txt (line 20)) (from versions: )
No distributions matching the version for elasticutils==0.7.dev (from -r requirements.txt (line 20))

需求文件的文档没有提到使用git+git协议说明符的链接,因此可能不支持.

有没有人能解决我的问题？

Answer 1

通常你的requirements.txt文件看起来像这样:

package-one==1.9.4
package-two==3.7.1
package-three==1.0.1
...

要指定Github仓库,您不需要package-name==约定.

下面的示例package-two使用GitHub仓库进行更新.@和之间的文本#表示包的具体内容.

指定提交哈希(41b95ec在更新的上下文中requirements.txt):

package-one==1.9.4
git+git://github.com/path/to/package-two@41b95ec#egg=package-two
package-three==1.0.1

指定分支名称(master):

git+git://github.com/path/to/package-two@master#egg=package-two

指定tag(0.1):

git+git://github.com/path/to/package-two@0.1#egg=package-two

指定release(3.7.1):

git+git://github.com/path/to/package-two@releases/tag/v3.7.1#egg=package-two

请注意,#egg=package-two此处不是注释,而是显式声明包名称

这篇博文有关于该主题的更多讨论.

Answer 2

"Editable"包语法可用于requirements.txt从各种VCS(git,hg,bzr,svn)导入包:

-e git://github.com/mozilla/elasticutils.git#egg=elasticutils

此外,可以指向特定的提交:

-e git://github.com/mozilla/elasticutils.git@000b14389171a9f0d7d713466b32bc649b0bed8e#egg=elasticutils

Answer 3

requirements.txt从pip 7.0:^1开始,允许以下方式指定git存储库中包的依赖性

[-e] git+git://git.myproject.org/SomeProject#egg=SomeProject
[-e] git+https://git.myproject.org/SomeProject#egg=SomeProject
[-e] git+ssh://git.myproject.org/SomeProject#egg=SomeProject
-e git+git@git.myproject.org:SomeProject#egg=SomeProject

对于Github,这意味着你可以做(​​注意省略-e):

git+git://github.com/mozilla/elasticutils.git#egg=elasticutils

为什么额外的答案？
我-e对其他答案中的旗帜感到有些困惑,所以这是我的澄清:

的-e或--editable标志表示该包是安装在<venv path>/src/SomeProject并因此没有在深埋<venv path>/lib/pythonX.X/site-packages/SomeProject它否则将被放置英寸²

文档

• ¹ https://pip.readthedocs.org/en/stable/reference/pip_install/#git
• ² https://pip.readthedocs.org/en/stable/reference/pip_install/#vcs-support

Answer 4

首先,安装git+git或git+https以任何方式安装.安装项目kronok分支的示例brabeion:

pip install -e git+https://github.com/kronok/brabeion.git@12efe6aa06b85ae5ff725d3033e38f624e0a616f#egg=brabeion

其次,用来pip freeze > requirements.txt在你的身上找到正确的东西requirements.txt.在这种情况下,你会得到

-e git+https://github.com/kronok/brabeion.git@12efe6aa06b85ae5ff725d3033e38f624e0a616f#egg=brabeion-master

三,测试结果:

pip uninstall brabeion
pip install -r requirements.txt

Answer 5

自pip v1.5(2014年1月1日发布:CHANGELOG,PR)以来,您还可以指定git repo的子目录来包含您的模块.语法如下所示:

pip install -e git+https://git.repo/some_repo.git#egg=my_subdir_pkg&subdirectory=my_subdir_pkg # install a python package from a repo subdirectory

注意:作为一个pip模块作者,理想情况下,如果可以的话,您可能希望将模块发布在自己的顶级仓库中.然而,此功能对于在子目录中包含python模块的一些预先存在的repos很有用.如果它们没有发布到pypi,您可能会被迫以这种方式安装它们.

Answer 6

看起来这也是一种有效的格式：

gym-tictactoe @ git+https://github.com/haje01/gym-tictactoe.git@84e22fc28fe192ba0040bdd56a697f63d3d4a3d5

如果您执行pip install "git+https://github.com/haje01/gym-tictactoe.git"，然后查看通过运行安装的内容pip freeze，您将看到以此格式描述的包，并且可以将其复制并粘贴到requirements.txt中。

Answer 7

这些答案都不适合我。唯一有效的是：

git+https://github.com/path_to_my_project.git

没有“e”，没有双“git”，也不需要以前的安装。

Answer 8

我发现让 pip3（v9.0.1，由 Ubuntu 18.04 的包管理器安装）来实际安装我告诉它安装的东西有点棘手。我发布这个答案是为了节省遇到此问题的任何人的时间。

将其放入requirements.txt 文件失败：

git+git://github.com/myname/myrepo.git@my-branch#egg=eggname

我所说的“失败”是指，当它从 Git 下载代码时，它最终安装了 PyPi 上的原始版本代码，而不是该分支上的存储库中的代码。

但是，安装提交而不是分支名称是可行的：

git+git://github.com/myname/myrepo.git@d27d07c9e862feb939e56d0df19d5733ea7b4f4d#egg=eggname

Answer 9

Github 有一个 zip 端点，在我看来它比使用 git 协议更可取。优点是：

• 您不必指定 #egg=<project name>
• Git 不需要安装在您的环境中，这对于容器化环境来说非常好
• 它与pip 散列和缓存一起工作得更好
• URL 结构更容易记住，更容易被发现

您通常希望 requirements.txt 条目看起来像这样，例如没有-e前缀：

https://github.com/org/package/archive/1a58aa586efd4bca37f2cfb9d9348958986aab6c.zip

从主分支安装：

https://github.com/org/package/archive/main.zip