什么是setup.py？

Question

谁能解释一下setup.py是什么以及如何配置或使用它？

Answer 1

setup.py是一个 python 文件，它的存在表明您将要安装的模块/包可能已经与 Distutils 一起打包和分发，Distutils 是分发 Python 模块的标准。

这使您可以轻松安装 Python 包。 通常这样写就足够了：

$ pip install . 

pip将使用setup.py来安装您的模块。 避免直接调用setup.py 。

https://docs.python.org/3/installing/index.html#installing-index

Answer 2

它有助于在您的机器上安装 python 包foo （也可以在virtualenv ），以便您可以从其他项目以及 [I]Python 提示中导入包foo 。

它与pip 、 easy_install等类似，

---

使用setup.py

让我们从一些定义开始：

包- 包含__init__.py文件的文件夹/目录。
模块- 具有.py扩展名的有效 python 文件。
分发- 一个包如何与其他包和模块相关。

假设您要安装一个名为foo的包。 那你做，

$ git clone https://github.com/user/foo  
$ cd foo
$ python setup.py install

相反，如果您不想实际安装它但仍想使用它。 然后做，

$ python setup.py develop  

此命令将创建指向站点包中源目录的符号链接，而不是复制内容。 因此，它非常快（特别是对于大包）。

---

创建setup.py

如果你有你的包树，

foo
├── foo
│   ├── data_struct.py
│   ├── __init__.py
│   └── internals.py
├── README
├── requirements.txt
└── setup.py

然后，在setup.py脚本中执行以下操作，以便将其安装在某些机器上：

from setuptools import setup

setup(
   name='foo',
   version='1.0',
   description='A useful module',
   author='Man Foo',
   author_email='foomail@foo.com',
   packages=['foo'],  #same as name
   install_requires=['wheel', 'bar', 'greek'], #external packages as dependencies
)

相反，如果您的包树更复杂，如下所示：

foo
├── foo
│   ├── data_struct.py
│   ├── __init__.py
│   └── internals.py
├── README
├── requirements.txt
├── scripts
│   ├── cool
│   └── skype
└── setup.py

然后，在这种情况下，您的setup.py将类似于：

from setuptools import setup

setup(
   name='foo',
   version='1.0',
   description='A useful module',
   author='Man Foo',
   author_email='foomail@foo.com',
   packages=['foo'],  #same as name
   install_requires=['wheel', 'bar', 'greek'], #external packages as dependencies
   scripts=[
            'scripts/cool',
            'scripts/skype',
           ]
)

---

向（ setup.py ）添加更多内容并使其体面：

from setuptools import setup

with open("README", 'r') as f:
    long_description = f.read()

setup(
   name='foo',
   version='1.0',
   description='A useful module',
   license="MIT",
   long_description=long_description,
   author='Man Foo',
   author_email='foomail@foo.com',
   url="http://www.foopackage.com/",
   packages=['foo'],  #same as name
   install_requires=['wheel', 'bar', 'greek'], #external packages as dependencies
   scripts=[
            'scripts/cool',
            'scripts/skype',
           ]
)

long_description在pypi.org 中用作包的 README 描述。

---

最后，您现在可以将您的包上传到PyPi.org，以便其他人可以使用pip install yourpackage安装您的包。

此时有两种选择。

• 发布在临时的test.pypi.org服务器上，让自己熟悉一下程序，然后发布在永久的pypi.org服务器上，供公众使用你的包。
• 如果您已经熟悉该程序并拥有您的用户凭据（例如，用户名、密码、包名称），请立即在永久pypi.org服务器上发布

一旦您的包名称在pypi.org 中注册，任何人都不能声明或使用它。 Python 打包建议使用麻线包进行上传（将包上传到 PyPi）。 因此，

(1) 第一步是使用以下方法在本地构建发行版：

# prereq: wheel (pip install wheel)  
$ python setup.py sdist bdist_wheel   

(2) 然后使用twine上传到 test.pypi.org 或 pypi.org：

$ twine upload --repository testpypi dist/*  
username: ***  
password: ***  

该包需要几分钟才能出现在 test.pypi.org 上。 一旦您对它感到满意，您就可以简单地将您的包上传到pypi.org的真实和永久索引：

$ twine upload dist/*  

或者，您还可以通过以下方式使用GPG对包中的文件进行签名：

$ twine upload dist/* --sign 

---

奖励阅读：

• 查看示例setup.py从这里真正的项目： torchvision-setup.py

• PEP 517 ，设置工具

• 为什么要麻线？ 使用麻线

Answer 3

setup.py是 Python 对多平台安装程序和make文件的回答。

如果您熟悉命令行安装，那么make && make install转换为python setup.py build && python setup.py install 。

一些包是纯 Python 的，并且只是字节编译。 其他可能包含本机代码，这将需要本机编译器（如gcc或cl ）和 Python 接口模块（如swig或pyrex ）。

Answer 4

如果您下载的包在根文件夹中具有“setup.py”，则可以通过运行来安装它

python setup.py install

如果你正在开发一个项目并且想知道这个文件有什么用，请查看Python 文档编写安装脚本

Answer 5

setup.py是一个 Python 脚本，通常随库或程序一起提供，以该语言编写。 它的目的是正确安装软件。

许多包将distutils框架与setup.py结合使用。

http://docs.python.org/distutils/

Answer 6

setup.py 可以用于两种场景，一是要安装Python包。 其次，您想创建自己的 Python 包。 通常标准的 Python 包有几个重要的文件，比如 setup.py、setup.cfg 和 Manifest.in。 在创建 Python 包时，这三个文件将决定（egg-info 文件夹下的 PKG-INFO 中的内容）名称、版本、描述、其他所需的安装（通常在 .txt 文件中）和其他一些参数。 setup.cfg 在创建包时由 setup.py 读取（可能是 tar.gz ）。 Manifest.in 是您可以定义包中应包含的内容的地方。 无论如何，您可以使用 setup.py 做很多事情，例如

python setup.py build
python setup.py install
python setup.py sdist <distname> upload [-r urltorepo]  (to upload package to pypi or local repo)

还有很多其他命令可以与 setup.py 一起使用。 求助

python setup.py --help-commands

Answer 7

setup.py是一个和其他文件一样的 Python 文件。 它可以采用任何名称，除了按照惯例将其命名为setup.py以便每个脚本没有不同的过程。

最常用的setup.py用于安装 Python 模块，但用于其他目的：

模块：

也许这是setup.py最著名的用法是在模块中。 虽然它们可以使用pip安装，但旧的 Python 版本默认不包含pip ，需要单独安装。

如果你想安装一个模块但不想安装pip ，唯一的选择是从setup.py文件安装模块。 这可以通过python setup.py install来实现。 这会将 Python 模块安装到根字典（没有pip 、 easy_install ）。

这种方法通常在pip失败时使用。 例如，如果所需包的正确 Python 版本无法通过pip可能是因为它不再维护，下载源代码并运行python setup.py install将执行相同的操作，除非需要编译的二进制文件,（但会忽略 Python 版本 - 除非返回错误）。

setup.py另一个用途是从源代码安装包。 如果模块仍在开发中，则轮文件将不可用，安装的唯一方法是直接从源安装。

构建 Python 扩展：

构建模块后，可以使用distutils 安装脚本将其转换为准备分发的模块。 构建完成后，可以使用上面的命令安装它们。

安装脚本很容易构建，一旦文件被正确配置，就可以通过运行python setup.py build进行编译（所有命令请参见链接）。

为了便于使用和按照惯例，它再次被命名为setup.py ，但可以采用任何名称。

赛通：

setup.py文件的另一个著名用途包括编译扩展。 这些需要一个带有用户定义值的设置脚本。 它们允许快速（但一旦编译就依赖于平台）执行。 这是文档中的一个简单示例：

from distutils.core import setup
from Cython.Build import cythonize

setup(
    name = 'Hello world app',
    ext_modules = cythonize("hello.pyx"),
)

这可以通过python setup.py build编译

Cx_冻结：

另一个需要安装脚本的模块是cx_Freeze 。 这会将 Python 脚本转换为可执行文件。 这允许包含、排除等许多命令，例如描述、名称、图标、包，并且一旦运行将生成可分发的应用程序。 文档中的一个示例：

import sys
from cx_Freeze import setup, Executable
build_exe_options = {"packages": ["os"], "excludes": ["tkinter"]} 

base = None
if sys.platform == "win32":
    base = "Win32GUI"

setup(  name = "guifoo",
        version = "0.1",
        description = "My GUI application!",
        options = {"build_exe": build_exe_options},
        executables = [Executable("guifoo.py", base=base)])

这可以通过python setup.py build编译。

那么什么是setup.py文件呢？

很简单，它是一个在 Python 环境中构建或配置某些东西的脚本。

分发的包应仅包含一个安装脚本，但将多个安装脚本组合成一个安装脚本的情况并不少见。 请注意，这通常涉及distutils但并非总是如此（如我在上一个示例中所示）。 要记住它只是以某种方式配置 Python 包/脚本。

它采用名称，因此在构建或安装时始终可以使用相同的命令。

Answer 8

当您使用setup.py下载软件包时，请打开您的终端（Mac、Linux）或命令提示符（Windows）。 使用cd并使用 Tab 按钮帮助您将路径设置为您下载文件的文件夹和setup.py所在的文件夹：

iMac:~ user $ cd path/pakagefolderwithsetupfile/

按回车键，你应该看到这样的：

iMac:pakagefolderwithsetupfile user$

然后在这个python setup.py install ：

iMac:pakagefolderwithsetupfile user$ python setup.py install

按enter 。 完毕！

Answer 9

为简单"__main__"当您调用其他答案中提到的安装函数时，setup.py 将作为"__main__"运行。 在 setup.py 中，您应该放置安装包所需的一切。

常用 setup.py 函数

以下两节讨论许多 setup.py 模块具有的两件事。

设置工具.setup

此功能允许您指定项目属性，例如项目名称、版本...。最重要的是，此功能允许您安装其他功能（如果它们打包正确）。 有关 setuptools.setup 的示例，请参阅此网页

setuptools.setup 的这些属性允许安装这些类型的包：

• 使用setuptools.findpackages导入项目并在PyPI 中列出的包：

  packages=find_packages(exclude=["docs","tests", ".gitignore", "README.rst","DESCRIPTION.rst"])

• 包不在PyPI 中，但可以使用dependency_links从 URL 下载

  dependency_links=["http://peak.telecommunity.com/snapshots/",]

自定义功能

在理想的世界中， setuptools.setup会为你处理一切。 不幸的是，情况并非总是如此。 有时您必须执行特定的操作，例如使用subprocess命令安装依赖项，以使您正在安装的系统处于适合您的软件包的正确状态。 尽量避免这种情况，这些功能会变得混乱，并且在OS甚至发行版之间经常有所不同。

Answer 10

要安装已下载的 Python 包，请解压缩存档并在其中运行 setup.py 脚本：

python setup.py install

对我来说，这一直感觉很奇怪。 将包管理器指向下载会更自然，就像在 Ruby 和 Nodejs 中所做的那样，例如。 gem install rails-4.1.1.gem

包管理器也更舒适，因为它熟悉且可靠。 另一方面，每个setup.py都是新颖的，因为它特定于包。 它需要对约定的信念“我相信这个 setup.py 与我过去使用过的其他命令采用相同的命令”。 这是对精神意志力的一种令人遗憾的征税。

我并不是说 setup.py 工作流程不如包管理器安全（我知道 Pip 只是在里面运行 setup.py），但我当然觉得它很尴尬和刺耳。 所有命令都指向同一个包管理器应用程序，这很和谐。 你甚至可能会喜欢上它。