setup.py是什么？

Question

什么是 setup.py 以及如何配置或使用它？

Answer 1

setup.py 是一个 Python 文件，它的存在表明您要安装的模块/包可能已通过 Distutils，这是分发 Python 模块的标准。

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

$ pip install . 

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

Answer 2

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

它的作用与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='[email protected]',
   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='[email protected]',
   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='[email protected]',
   url="http://www.foopackage.example/",
   packages=['foo'],  #same as name
   install_requires=['wheel', 'bar', 'greek'], #external packages as dependencies
   scripts=[
            'scripts/cool',
            'scripts/skype',
           ]
)

long_description在pypi.org中用作包的自述文件描述。

---

最后，您现在已准备好将软件包上传到 PyPi.org，以便其他人可以使用 pip 安装你的包。

此时有两个选择。

• 在临时 test.pypi.org 服务器中发布自己熟悉该过程，然后将其发布在永久pypi.org服务器供公众使用您的包。
• 如果您已经熟悉，请立即在永久 pypi.org 服务器上发布 请按照该过程并获得您的用户凭据（例如，用户名、密码、包名称）

一旦您的包名称在 pypi 中注册， 。 org，没有人可以声明或使用它。 Python 打包建议使用 twine 包< /a> 用于上传（将包上传到 PyPi）。因此，

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

   # 先决条件：wheel (pip install wheel)
   $ python setup.py sdist bdist_wheel
   

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

   $ twine upload --repository testpypi dist/*
   用户名：***
   密码： ***
   

包需要几分钟时间才会出现在 <代码>test.pypi.org。一旦您对它感到满意，您就可以将您的包上传到真实的＆amp; pypi.org 的永久索引只需：

$ twine upload dist/*

或者，您还可以使用 < 来签署包中的文件code>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 安装。

有些包是纯Python的，并且仅是字节编译的。其他可能包含本机代码，这将需要本机编译器（例如 gcc 或 cl）和 Python 接口模块（例如 swig 或 >耐热玻璃）。

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

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

构建Python扩展：

构建模块后，可以使用distutils 安装脚本。构建完成后，可以使用上面的命令安装它们。

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

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

Cython：

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_Freeze：

另一个需要安装脚本的模块是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 构建。

那么什么是 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

为了简单起见，当您调用 安装函数提到的其他答案。在 setup.py 中，您应该放置安装软件包所需的所有内容。

常见的 setup.py 函数

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

setuptools.setup

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

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

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

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

• 包不在 PyPI< /a>，但可以使用 dependency_links

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

自定义函数

理想情况下的 世界，setuptools.setup 将为您处理一切。不幸的是情况并非总是如此。有时您必须执行特定的操作，例如使用 subprocess 命令安装依赖项，以让您要安装的系统处于适合您的软件包的正确状态。尽量避免这种情况，这些函数会变得混乱，并且在 操作系统 和甚至分发。

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），但我当然觉得它很尴尬和不和谐。所有命令都指向同一个包管理器应用程序，这是一种和谐。您甚至可能会喜欢它。