python - 如何 `pip install`具有Git依赖项的软件包？

我有一个名为some-library的私有(private)库(实际名称已更改)，其安装文件如下所示:

setup(
    name='some-library',

    // Omitted some less important stuff here...

    install_requires=[
        'some-git-dependency',
        'another-git-dependency',
    ],
    dependency_links=[
        'git+ssh://[email protected]/my-organization/some-git-dependency.git#egg=some-git-dependency',
        'git+ssh://[email protected]/my-organization/another-git-dependency.git#egg=another-git-dependency',
    ],
)

所有这些Git依赖项可能都是私有(private)的，因此installation via HTTP不是一个选择。我可以在python setup.py install的根目录中使用python setup.py develop和some-library，而不会出现问题。

但是，通过Git安装不起作用:

pip install -vvv -e 'git+ssh://[email protected]/my-organization/[email protected]#egg=some-library'

该命令在查找some-git-dependency时失败，错误地认为它需要从PyPI获取依赖项，然后在断定它不在PyPI上之后失败。我的第一个猜测是尝试使用--process-dependency-links重新运行该命令，但是这发生了:

   Cannot look at git URL git+ssh://[email protected]/my-organization/some-git-dependency.git#egg=some-git-dependency
   Could not find a version that satisfies the requirement some-git-dependency (from some-library) (from versions: )

为什么会产生这个模糊的错误？用gitt编码可能带有私有(private)Git依赖关系的软件包的正确方法是什么？

最佳答案

两种选择

像使用那样使用dependency_links。有关详情，请参见下文。

在setup.py的dependency_links旁边，使用特殊的dependency-links.txt收集所有必需的软件包。然后将此包添加到requirements.txt中。这是我的recommendend选项，如下所述。

# dependency-links.txt
git+ssh://...@tag#egg=package-name1
git+ssh://...@tag#egg=package-name2
# requirements.txt (per deployed application)
-r dependency-links.txt

虽然选项2给程序包管理增加了一些额外的负担，即保持dependency-links.txt为最新，但它使安装程序包变得容易得多，因为您会忘记在--process-dependency-link上添加pip install选项。

也许更重要的是，使用dependency-links.txt，您可以指定要在部署中安装的确切版本，这是您希望在CI / CD环境中使用的版本，没有比安装某些版本更危险的了。但是，从软件包维护者的 Angular 来看，指定最低版本(例如:

    # setup.py in a package
    ...
       install_requires = [ 'foo>1.0', ... ]

太好了，因为它使您的程序包可以与具有相似依赖性但可能在不同版本上的其他程序包很好地协作。但是，在已部署的应用程序中，如果程序包之间存在相互矛盾的要求，则仍然可能造成困惑。例如。软件包A可以使用foo>1.0，软件包B可以使用foo<=1.5，而最新版本是foo==2.0。您可以使用dependency-links.txt来具体化，对所有软件包应用一个版本:

    # dependency-links.txt
    foo==1.5

为了使其正常工作，您需要为ipp添加--process-dependency-links以识别对github的依赖关系，例如

pip install --process-dependency-links -r private-requirements.txt

请注意，由于pip 8.1.0，您可以将此选项添加到requirements.txt。不利的一面是，它适用于所有已安装的软件包，可能会带来意想不到的后果。就是说，我发现使用dependency-links.txt是一个更安全，更易管理的解决方案。



共有三个选项:

在每个必需软件包的存储库上添加协作者。这些协作者需要使用github设置其ssh密钥，才能正常工作。然后使用git+ssh://...

向每个存储库添加一个部署密钥。缺点是您需要将相应的私钥分发给所有需要部署的计算机。再次使用git+ssh://...

在保存私有(private)存储库的github帐户上添加个人访问 token 。然后，您可以使用git+https://[email protected]/...的缺点是，访问 token 将具有对相应github帐户上所有公共(public)和私有(private)存储库的读写访问权限。从正面来看，不再需要分发和管理每个存储库的私钥，并且循环密钥要简单得多。在每个开发人员都可以访问所有存储库的内部环境中，我发现这对每个人都是最有效，最轻松的方式。 YMMV

关于python - 如何 `pip install`具有Git依赖项的软件包？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/36544700/