如何使用 Python distutils？

Question

我在 python 中编写了一个快速程序来将 gtk GUI 添加到 cli 程序。我想知道如何使用 distutils 创建安装程序。因为它只是一个命令行应用程序的 GUI 前端，所以它只能在 *nix 中运行，所以我不担心它是跨平台的。

我的主要目标是为 debian/ubuntu 用户创建一个 .deb 包，但我不了解 make/configure 文件。到目前为止，我主要是一名网络开发人员。

编辑：有谁知道一个使用 distutils 的项目，所以我可以看到它在运行中，你知道，实际上尝试构建它吗？

这里有一些有用的链接

• Ubuntu Python Packaging Guide

  本指南非常很有帮助。我不知道在最初的 gooling 浪潮中我是怎么错过的。它甚至会引导您打包现有的 python 应用程序

• The Ubuntu MOTU Project

  这是 ubuntu 官方的包维护项目。任何人都可以加入，并且有很多关于创建各种类型包的教程和信息，其中包括上面的“python 打包指南”。

• "Python distutils to deb?" - Ars Technica Forum discussion

  根据这次谈话，你不能只使用 distutils。它不遵循 debian 打包格式（或类似的格式）。我想这就是你需要 dh_make 的原因，如 Ubuntu 打包指南中所示

• "A bdist_deb command for distutils

  这个有一些有趣的讨论（这也是我找到 ubuntu 指南的方式）关于连接一个 zip 文件和一个 shell 脚本以创建某种通用可执行文件（任何带有 python 和 bash 的东西）。诡异的。让我知道是否有人找到有关此做法的更多信息，因为我从未听说过。

• Description of the deb format and how distutils fit in - python mailing list

Answer 1

请参阅distutils simple example。基本上就是这样，除了真正的安装脚本通常包含更多信息。不过，我还没有看到任何从根本上更复杂的东西。本质上，您只是给它一个需要安装的列表。有时你需要给它一些映射字典，因为源树和安装的树可能不一样。

这是一个真实的（匿名）示例：

#!/usr/bin/python 

from distutils.core import setup 

setup (name = 'Initech Package 3', 
          description = "Services and libraries ABC, DEF", 
          author = "That Guy, Initech Ltd", 
          author_email = "that.guy@initech.com", 
          version = '1.0.5', 
          package_dir = {'Package3' : 'site-packages/Package3'}, 
          packages = ['Package3', 'Package3.Queries'], 
          data_files = [ 
                       ('/etc/Package3', ['etc/Package3/ExternalResources.conf']) 
          ])

Answer 2

apt-get install python-stdeb

Python 到 Debian 源码包转换实用程序

这个包提供了一些工具，通过新的 distutils 命令 sdist_dsc 从 Python 包生成 Debian 包。为 Debian 软件包提供了自动默认值，但生成的软件包的许多方面都可以通过配置文件进行自定义。

• pypi-install 将查询 Python 包索引 (PyPI) 包，下载它，从中创建一个 .deb，然后安装 .deb。
• py2dsc 会将 distutils 构建的源 tarball 转换为 Debian 源码包。

Answer 3

大多数 Python 程序将使用 distutils。 Django 是一个 - 见 http://code.djangoproject.com/svn/django/trunk/setup.py

你也应该阅读the documentation，因为它非常全面并且有一些很好的例子。

Answer 4

我发现以下tutorial 非常有帮助。它比 distutils 文档短，并解释了如何逐步设置典型项目。

Answer 5

distutils 一旦你掌握了窍门，就真的不是那么难了。只需输入一些元信息（程序名称、作者、版本等），然后选择要包含的文件。例如，下面是一个来自相当复杂的 python 库的示例 distutils setup.py 模块：

Kamaelia setup.py

请注意，这不处理任何数据文件或诸如此类的东西，所以是 YMMV。

另一方面，我同意 distutils 文档可能是 python 最糟糕的文档之一。它在某些领域极具包容性，但在其他领域却忽略了一些非常重要的信息。