stdeb 0.10.0

Python 3 支持

如以下更详细地解释，stdeb 的核心是 sdist_dsc distutils 命令。该命令运行一次以生成 Debian 源软件包。这个 Debian 源软件包可以指定为 Python 2、Python 3 或两者都构建软件包。此外，这个生成可以使用 Python 2 或 Python 3 解释器来完成。默认情况下，只为正在使用的 Python 版本构建软件包。要覆盖此设置，请使用 --with-python2=True 或 --with-python3=True 作为 sdist_dsc distutils 命令的参数（或同时使用两者以确保）。例如，仅使用 Python 3 解释器构建 Python 3 软件包

python3 setup.py --command-packages=stdeb.command bdist_deb

使用 Python 3 解释器构建 Python 2 和 Python 3 软件包（并且只有 Python3 软件包安装脚本）

python3 setup.py --command-packages=stdeb.command sdist_dsc --with-python2=True --with-python3=True --no-python2-scripts=True bdist_deb

新闻

• 2020-10-28: 版本 0.10.0。请参阅 下载页面。

• 错误修复

  • 在 PyPI API 调用之间添加睡眠以避免速率限制 (#173)

• 改进

  • 如果设置了 SOURCE_DATE_EPOCH，则使用它为生成的 changelog 中的时间戳生成可重复构建的工件 (#166)

  • 将 debhelper 兼容版本从 7 更新到 9 (#158)

  • 添加标志 –with-dh-systemd (#162)

  • 添加对 DEBEMAIL 环境变量的支持 (#168)

  • 使用 setuptools 的“url”字段在 debian/control 中的“Homepage”字段中 (#169)

  • dh_virtualenv：指定 Python 版本 (#165)

  • 添加兼容标志以修改 Debian 兼容级别 (#163)

• 外观：* 从 debian/control 和 rules 文件中删除多余的换行符 (#167) * 使用 flake8 在 Travis CI 中检查样式，更新代码以符合规范 (#171)

• 2020-06-11: 版本 0.9.1。请参阅 下载页面。

• 错误修复

  • 处理 zip tarball 中的带空格的路径 (#150)

  • 修复 Python 3 中的 map() 迭代器问题 (#152)

  • 修复使用仅 Python 3 时检查 python3-all（而不是 python-all）的问题 (#154)

• 改进

  • 在 Python 中获取日期，避免在 macOS 上要求 date (#115)

  • 添加配置文件选项 Python2-Depends-Name (#156)

  • 添加选项 --with-dh-virtualenv (#155)

  • 添加选项 ignore-source-changes (#151)

• 2019-12-09: 版本 0.9.0。请参阅 下载页面。

• 错误修复

  • 修复在Python 3下应用补丁文件的问题

• 改进

  • 向sdist_dsc和bdist_deb命令添加--sign-results

  • 将--debian-version添加到命令行程序选项

  • 在debian/control中添加对Breaks / Breaks3的支持

  • 添加对Suite3选项的支持

  • 在pypi-install中支持zip文件

• 破坏性变更

  • 移除已弃用的dh_desktop调用

• 2015-02-18: 版本 0.8.5. 请参阅下载页面。错误修复：撤销了在虚拟环境中构建时安装到虚拟环境的更改。改进：添加了–allow-virtualenv-install-location以允许安装到虚拟环境位置。支持Debian Squeeze (6)，Debian Wheezy (7)，Ubuntu Precise (12.04)，Ubuntu Trusty (14.04)及以后版本。

• 2015-02-16: 版本 0.8.4. 请参阅下载页面。错误修复：再次在Python 3.4（例如Ubuntu Trusty）上工作。改进：改进了Python 3的定制（Dirk Thomas添加了force-x-python3-version和X-Python3-Version，Louis添加了对Recommends3，Suggests3，Provides3和Replaces3的支持。支持Debian Squeeze (6)，Debian Wheezy (7)，Ubuntu Precise (12.04)，Ubuntu Trusty (14.04)及以后版本。

• 2015-02-14: 版本 0.8.3. 请参阅下载页面。这是一个错误修复版本，修复了Unicode支持的几个方面。在Debian Squeeze (6)，Debian Wheezy (7)和Ubuntu Precise (12.04)上测试通过。支持Python 3.4（例如Ubuntu Trusty 14.04）的错误被意外破坏，并在0.8.3版本中修复。

• 2014-8-14: 版本 0.8.2. 请参阅下载页面。这是一个错误修复版本，修复了一个严重的问题，在某些情况下，如果只请求Python 3包，则会构建Python 2包。

• 2014-8-10: 版本 0.8.1. 请参阅下载页面。由于0.8.0中的错误，此版本是0.8系列的第一个宣布版本。自0.7.1以来的亮点

  • 完全支持Python 3。这包括从Python 3运行以及为Python 3生成软件包。默认情况下，使用Python 3运行时构建Python 3软件包，使用Python 2运行时构建Python 2软件包。也可以使用命令行选项来为其他Python解释器构建软件包。

  • 为源软件包构建.changes文件。虽然这仍然必须签名后才能上传到PPA等，但在某些情况下仍然应该有用。

  • 切换到Debian源格式3.0（quilt）。实际上，以前与源软件包一起提供的.diff.gz文件现在被.deb.tar.gz文件所替代。

  • 在与PyPI通信时验证SSL证书。（验证需要Requests >= 0.8.8。）

  • 许多错误修复。

• 2014-05-05: 版本 0.7.1. 请参阅下载页面。本发布版本的亮点（您还可以查阅完整的变更日志）。由于0.7.0中的错误，此版本是0.7系列的第一个宣布版本。自0.6.0以来的亮点

  • 新命令：pypi-download和pypi-install，分别用于直接从PyPI下载和安装软件包。py2dsc-deb直接从源tarball创建.deb文件。

  • 新distutils命令：install_deb允许您直接将Python包安装为标准系统软件包。

  • 许多错误修复，包括PyPI的新URL。

  • 通过Travis CI自动运行测试套件

  • 感谢许多人的帮助，尤其是Piotr Ożarowski对stdeb的帮助。

• 2010-06-18: 版本 0.6.0. 请参阅下载页面。本发布版本的亮点（您还可以查阅完整的变更日志）

  • 新增了一个用于在您的 setup.py 文件旁边构建 debian/ 目录的 debianize 命令。

  • 错误修复。

• 2010-01-09: 版本 0.5.1. 错误修复版本。请参阅下载页面，变更日志和发布说明。

• 2009-12-30: 版本 0.5.0。请参阅下载页面。本次发布的亮点（您也可以参考完整的变更日志）

  • 新增了一个 pypi-install 脚本，它会自动下载、创建 .deb 文件并从Python 包索引 (PyPI) 安装软件包。

  • 移除了对 setuptools 的依赖。

  • 新增了一个选项（–guess-conflicts-provides-replaces）用于查询原始 Debian 软件包的 Conflicts/Provides/Replaces 信息。

  • 由于这些更改以及修复了一些 bug/warts，进行了一些小的向后不兼容的更改和弃用。请参阅发布说明。

• 2009-12-28: 发布了版本 0.4.3。请参阅下载页面。请参阅变更日志和发布说明。

• 2009-11-02: 发布了版本 0.4.2。请参阅下载页面。请参阅变更日志和发布说明。

• 2009-10-04: 发布了版本 0.4.1。请参阅下载页面。请参阅变更日志和发布说明。

• 2009-09-27: 发布了版本 0.4。请参阅下载页面。本版本切换到 debhelper 7。请参阅0.4 版本变更日志。

包括 0.3.2 在内的所有早期版本都与 Ubuntu Hardy 兼容。

• 2009-10-04: 发布了版本 0.3.2。请参阅下载页面。请参阅0.3.2 版本变更日志

• 2009-09-27: 发布了版本 0.3.1。请参阅下载页面。请参阅0.3.1 版本变更日志

• 2009-03-21: 发布了版本 0.3。请参阅下载页面。请参阅0.3 版本变更日志

• 2009-02-17: 发布了版本 0.2.3。请参阅下载页面。请参阅0.2.3 版本变更日志

• 2009-01-29: 发布了版本 0.2.2。请参阅下载页面。请参阅0.2.2 版本变更日志

• 2008-04-26: 发布了版本 0.2.1。请参阅下载页面。请参阅0.2.1 版本变更日志

• 2008-04-26: 发布了版本 0.2。请参阅下载页面。请参阅0.2 版本变更日志

• 2007-04-02: 发布了版本 0.2.a1。请参阅旧下载页面。

• 2006-06-19: 发布了版本 0.1。请参阅旧下载页面。

命令

pypi-download [options] mypackage

pypi-install [options] mypackage

py2dsc [options] mypackage-0.1.tar.gz # uses pre-built Python source package

py2dsc-deb [options] mypackage-0.1.tar.gz # uses pre-built Python source package

python setup.py --command-packages=stdeb.command sdist_dsc

python setup.py --command-packages=stdeb.command bdist_deb

sudo python setup.py --command-packages=stdeb.command install_deb

python setup.py --command-packages=stdeb.command debianize

[global]
command-packages: stdeb.command

示例

这些都假设您已将 stdeb 安装在系统 Python 路径中。stdeb 也可以从非系统 Python 路径（例如 virtualenv）运行。

pypi-install mypackage

python setup.py --command-packages=stdeb.command bdist_deb

wget http://pypi.python.org/packages/source/R/Reindent/Reindent-0.1.0.tar.gz
py2dsc Reindent-0.1.0.tar.gz

cd deb_dist/reindent-0.1.0/
dpkg-buildpackage -rfakeroot -uc -us

cd ..
sudo dpkg -i python-reindent_0.1.0-1_all.deb

python setup.py --command-packages=stdeb.command install_deb

wget http://pypi.python.org/packages/source/R/Reindent/Reindent-0.1.0.tar.gz
tar xzf Reindent-0.1.0.tar.gz
cd Reindent-0.1.0

python setup.py --command-packages=stdeb.command sdist_dsc

cd deb_dist/reindent-0.1.0
dpkg-buildpackage -rfakeroot -uc -us

cd ..
sudo dpkg -i python-reindent_0.1.0-1_all.deb

下载

文件可在 下载页面 上找到（对于旧版本，请参阅 旧下载页面）。

git仓库可在 http://github.com/astraw/stdeb 找到

安装（或，使用 stdeb 创建 stdeb 安装程序）

为了好玩，下面是使用stdeb安装stdeb的方法。请注意，stdeb也存在于Debian和Ubuntu中，所以这个配方只是为了安装较新的stdeb。

STDEB_VERSION="0.10.0"

# Download stdeb
wget http://pypi.python.org/packages/source/s/stdeb/stdeb-$STDEB_VERSION.tar.gz

# Extract it
tar xzf stdeb-$STDEB_VERSION.tar.gz

# Enter extracted source package
cd stdeb-$STDEB_VERSION

# Build .deb (making use of stdeb package directory in sys.path).
python setup.py --command-packages=stdeb.command bdist_deb

# Install it
sudo dpkg -i deb_dist/python-stdeb_$STDEB_VERSION-1_all.deb

背景

对于普通的Python包，其源代码分发（使用 python setup.py sdist 生成的 python_package.tar.gz）包含构建Debian源代码包所需的大部分内容。这种近似相等性促使我编写了这个distutils扩展，它会执行setup.py文件以提取相关信息。也可以选择使用 setuptools。

我最初编写这个是为了将我自己的几个Python包Debian化，但我感觉它可能具有普遍的实用性。它在理论上至少看起来与 easydeb、Logilab的Devtools、bdist_dpkg、bdist_deb、pkgme 和 dh-virtualenv 相似。

特性

• 为python-support支持的所有Python版本创建一个包。（可以使用 XS-Python-Version: 配置选项来限制此范围。）

• 自动将Python包名转换为有效的Debian包名。

• 尝试自动转换版本号，以保持排序。另请参阅配置选项 Forced-Upstream-Version。

• 精细控制版本号。（Debian-Version、Forced-Upstream-Version、Upstream-Version-Prefix、Upstream-Version-Suffix 配置选项。）

• 安装 .desktop 文件。（MIME-Desktop-Files 配置选项。）

• 安装 .mime 和 .sharedmimeinfo 文件。（MIME-File 和 Shared-MIME-File 配置选项。）

• 安装版权文件。（Copyright-File 配置选项。）

• 对上游源代码应用补丁。（Stdeb-Patch-File 配置选项。）

• 将环境变量传递给setup.py脚本。（Setup-Env-Vars 配置选项。）

自定义生成的 Debian 源软件包（配置选项）

stdeb将尝试提供合理的默认值，但这些只是猜测。

有两种方法可以自定义stdeb生成的Debian源代码包。首先，您可以为distutils命令提供选项。其次，您可以提供一个 stdeb.cfg 文件。

python setup.py --command-packages=stdeb.command sdist_dsc --debian-version 0MyName1

[sdist_dsc]
debian-version: 0MyName1

python setup.py sdist_dsc --debian-version 0MyName1 bdist_deb

[DEFAULT]
Depends: python-numpy
XS-Python-Version: >= 2.6

可重复构建

默认情况下，stdeb 使用当前时间作为生成的更改日志文件中的时间戳。这会导致非可重复构建，因为每次调用都会生成不同的更改日志 / .deb。可以通过将 SOURCE_DATE_EPOCH 环境变量设置为固定的时间戳（例如，当版本被标记或最后提交时）来设置该时间戳，这将在更改日志中使用。这将确保在重复调用时产生的 .deb 可重复。

有关可重复构建和此特定环境变量的更多信息，请参阅 https://reproducible-builds.org/docs/source-date-epoch/

先决条件

• Python 2.7 或 Python 3.x

• 标准 Debian 工具，如 date、dpkg-source 和 Debhelper 7（如果需要支持没有 dh7 的旧发行版，请使用 stdeb 0.3.x）

• 如果您的 setup.py 使用 setuptools 功能 setup_requires 或 install_requires，则在运行任何 stdeb 命令之前，必须运行 apt-file update。

待办事项

• 输出符合 Debian Python Policy 规范或 新 python 政策。这包括几个方面，其中之一是

  • 自定义更改日志的能力

  • 能够包含作为 -doc 包的项目提供的文档

  • 在 debian/copyright 中包含许可证信息

  • 能够将项目提供的示例、测试和数据作为一个单独的包包含

  • 还有更多未列出

• 创建（更好的）文档

• 使用标准 distutils 机制记录输出

• 重构源代码以拥有更简单、更合理的结构

志愿者召集令

我没有太多时间来做这件事。除非人们站出来贡献力量，否则这个项目很可能会只是一个其潜在能力的影子。人们可以帮助的方式有很多。特别是，如果项目引起任何兴趣，我非常希望找到一个共同维护者或维护者。其次，我会感激 Debian 开发者或 Ubuntu MOTUs 关于 Python 打包的复杂细节的建议。

邮件列表

请将所有问题发送至 distutils-SIG

许可证

MIT 风格许可证。版权所有 (c) 2006-2015 stdeb 作者。

有关详细信息，请参阅源分发中提供的 LICENSE.txt 文件。

作者

• Andrew Straw <strawman@astraw.com>

• Pedro Algarvio，又名 s0undt3ch <ufs@ufsoft.org>

• Gerry Reno（bdist_deb 的初始实现）

额外致谢

• Zooko O’Whielacronx 为 autofind-depends 补丁。

• Brett（姓氏未知）为 –ignore-install-requires 补丁。

• Ximin Luo 为修复了一个错误。

• Alexander D. Sedov 为错误修复和建议。

• Michele Mattioni 为错误修复。

• Alexander V. Nikolaev 为 debhelper 构建系统规范。

• Roland Sommer 为描述字段错误修复。

• Barry Warsaw 提出了 debianize 命令。

• Asheesh Laroia 更新了 PyPI URL。

• Piotr Ożarowski 实现了 dh_python2 支持。

• Nikita Burtsev 进行了 Unicode 测试和修复。

• Mikołaj Siedlarek 修复了一个错误。

• Dirk Thomas 为 –force-x-python3-version 和 X-Python3-Version。

• Louis 为 Recommends3、Suggests3、Provides3 和 Replaces3 支持。

• kzwin 为与 virtualenv 的互操作。

• GitHub 为托管服务。

• WebFaction（又名 python-hosting）为之前的托管服务。

• TravisCI 为持续集成。