News

• 2009-02-17: Version 0.2.3 Released. See the download page. See the Changelog for 0.2.3
• 2009-01-29: Version 0.2.2 Released. See the download page. See the Changelog for 0.2.2
• 2008-04-26: Version 0.2.1 Released. See the download page. See the Changelog for 0.2.1
• 2008-04-26: Version 0.2 Released. See the download page. See the Changelog for 0.2
• 2007-04-02: Version 0.2.a1 Released. See the old download page.
• 2006-06-19: Version 0.1 Released. See the old download page.

Invocation

All methods eventually result in a call to the sdist_dsc distutils command. You may prefer to do so directly:

python -c "import stdeb; execfile('setup.py')" sdist_dsc

Alternatively, two scripts are provided:

stdeb_run_setup [options] # calls "python setup.py sdist_dsc [options]"

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

In all cases, a Debian source package is produced from unmodified Python packages. The following files are produced in a newly created subdirectory deb_dist:

• packagename_versionname.orig.tar.gz
• packagename_versionname-debianversion.dsc
• packagename_versionname-debianversion.diff.gz

These can then be compiled into binary packages using the standard Debian machinery (e.g. dpkg-buildpackage).

Quickstart example

This generates a source package:

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

This turns it into a .deb:

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

This installs it:

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

Another example, with more explanation

This example is more useful if you don't have a Python source package (.tar.gz file generated by python setup.py sdist). For the sake of illustration, we do download such a tarball, but immediately unpack it (alternatively, use a version control system to grab the unpacked source of a package):

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

The following will generate a directory deb_dist containing the files reindent_0.1.0-1.dsc, reindent_0.1.0.orig.tar.gz and reindent_0.1.0-1.diff.gz, which, together, are a debian source package:

python setup.py sdist_dsc

(For packages that don't use setuptools, you need to get the stdeb monkeypatch for the sdist_dsc distutils command. So, do this: python -c "import stdeb; execfile('setup.py')" sdist_dsc, or use the command stdeb_run_setup, which does just this.)

The source generated in the above way is also extracted (using dpkg-source -x) and placed in the deb_dist subdirectory. To continue the example above:

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

Finally, the generated package can be installed:

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

For yet another example of use, with still more explanation, see allmydata-tahoe ticket 251.

Download

Files are available at the download page (for older releases, see the old download page).

The git repository is available at http://github.com/astraw/stdeb

Background

For the average Python package, its source distribution (python_package.tar.gz created with python setup.py sdist) contains nearly everything necessary to make a Debian source package. This near-equivalence encouraged me to write this distutils extension, which executes the setup.py file to extract relevant information. This process is made significantly easier through the use of setuptools.

setuptools is used because of some nice features. For example, setuptools makes the job of "Debianizing" python console and gui scripts much easier.

I wrote this initially to Debianize several Python packages of my own, but I have the feeling it could be generally useful. It appears similar, at least in theory, to easydeb, Logilab's Devtools, bdist_dpkg and bdist_deb.

Features

• Create a package for all Python versions supported by pycentral. (Limiting this range is possible with the XS-Python-Version: config option.)
• Automatic conversion of Python package names into valid Debian package names.
• Attempt to automatically convert version numbers such that ordering is maintained. (The setuptools version sorting is different than the Debian version sorting.) See also the config option Forced-Upstream-Version.
• Fine grained control of version numbers. (Debian-Version, Forced-Upstream-Version, Upstream-Version-Prefix, Upstream-Version-Suffix config options.)
• Install .desktop files. (MIME-Desktop-Files config option.)
• Install .mime and .sharedmimeinfo files. (MIME-File and Shared-MIME-File config options.)
• Install copyright files. (Copyright-File config option.)
• Apply patches to upstream sources. (Stdeb-Patch-File config option.)
• Pass environment variables to setup.py script. (Setup-Env-Vars config option.)

Customizing the produced Debian source package (config options)

stdeb will attempt to provide reasonable defaults, but these are only guesses.

To customize the Debian source package produced, you may write config files of the format understood by ConfigParser. When building each package, stdeb looks for the existance of a stdeb.cfg file in the .egg-info directory. You may specify an additional config file with the command-line option --extra-cfg-file.

For an example configuration file I use to build several packages, please see http://stdeb.python-hosting.com/wiki/stdeb_all.cfg

Prerequisites

• Python 2.5 or higher (older python OK if you use subprocess.py with backports from Python 2.5)
• Standard Debian utilities (e.g. date and dpkg-source)

Using stdeb on stdeb

There is a chicken-and-egg problem when trying to make a Debian package of stdeb with stdeb. Here's a recipe to avoid it:

# in the stdeb distribution directory (with setup.py)
python setup.py sdist
python setup.py build
PYTHONPATH="build/lib" python stdeb/py2dsc.py dist/stdeb-VERSION.tar.gz

TODO

• Make output meet Debian Python Policy specifications or the new python policy. This will include several things, among which are:
  • the ability to make custom changelogs
  • the ability to include project-supplied documentation as a -doc package
  • include license information in debian/copyright
  • the ability to include project-supplied examples, tests, and data as a separate package
  • much more not listed
• Create (better) documentation
• Log output using standard distutils mechanisms
• Refactor the source code to have a simpler, more sane design

Call for volunteers

I don't have a lot of time for this. This project stands a very real chance of being only a shadow of its potential self unless people step up and contribute. There are numerous ways in which people could help. In particular, I'd be interested in finding a co-maintainer or maintainer if the project generates any interest. Secondarily, I would appreciate advice from Debian developers or Ubuntu MOTUs about the arcane details of Python packaging.

Mailing list

Please address all questions to the distutils-SIG

License

MIT-style license. Copyright (c) 2006-2009 stdeb authors.

See the LICENSE.txt file provided with the source distribution for full details.

Authors

Andrew Straw <strawman@astraw.com> Pedro Algarvio, aka, s0undt3ch <ufs@ufsoft.org>

Additional Credits

• Zooko O'Whielacronx for the autofind-depends patch
• Brett (last name unknown) for the --ignore-install-requires patch
• GitHub for hosting services.
• WebFaction (aka python-hosting) for previous hosting services.