如何在 Python 的 setup.py 中包含和安装本地依赖项？

Question

我正在创建一个 setup.py 来分发我的应用程序。 该应用程序有许多可以通过 pip 安装的依赖项，它还有一些无法从 PyPI 安装的自定义依赖项。

所以，我创建了一个 custom_package_0.1.whl，它将包含在分发中，并且必须在 setup.py 从 install_requires 安装所有内容后作为依赖项安装。

想象以下应用结构：

my_app/
    win_deps/custom_package_0.1.whl
    my_app/
        __init__.py
        main.py
        setup.py
        setup.cfg

我该怎么做？

Answer 1

基于上面的@RunOrVeith 答案，这适用于使用相对路径的本地车轮文件。所以它可以在各种主机上安装第三方包。适用于 Windows 和 Unix。

setup(# ... other arguments
      install_requires=[
          f"my-lib @ file://localhost/{os.getcwd()}/libs/my_lib-xxx-none-any.whl"
      ]
)

Answer 2

有一种称为Direct references 的新技术（自版本 19.1 起）。 假装你的文件托管在本地主机上。

from setuptools import setup

path_to_my_project = "/home/user/projects/my_package"  # Do any sort of fancy resolving of the path here if you need to


setup(# ... other arguments
      install_requires=[f"my_package @ file://localhost/{path_to_my_project}#egg=my_package"]
      )

Answer 3

扩展 wiesiu_p 的答案，您可以通过链接到其源目录来安装依赖项，该目录有自己的setup.py。

假设你有你的依赖my-dependency的源文件，并且my-dependency的根有它自己的setup.py。在您的应用程序的setup.py：

setup(
  ...,
  install_requires=['other-dependency','my-dependency'],
  dependency_links=[
    # location to your my-dependency project directory
    ''.join(['file:\\', os.path.join(os.getcwd(), 'path', 'to', 'my-dependency#egg=my-dependency-1.0')])
  ]
)

现在，如果您使用应用程序的setup.py 运行python setup.py install，它将安装my-dependency。

Answer 4

有可能，但不确定您应该使用哪个 setuptools 版本。 步骤：

在 setup.py 中

setup(
  ...,
  install_requires=['my-package'],
  dependency_links=[
    # location to your egg file
    os.path.join(os.getcwd(), 'deps', 'my_package-1.0.0-py3.5.egg')
  ]
)

重要的是您的位置不应通过 URL 模式测试，并且 egg 文件名应具有结构 <package_name_with_no_hyphens>-<version>-<py_version>.egg

Answer 5

有几个选项可供您选择：

1. 将您的包上传到某个服务器，并提供带有dependency_links 的URL。
2. 您可以将您的 python 包放在您的 my_app 包中，并将其与 packages 参数链接，而不是使用轮文件。
3. 更hacky的方法是使用setuptools api，然后自己安装包。