Text of docs.python.org › 3.11 › distutils › builtdist.html as Styx crawled it on Oct 12, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

5. Creating Built Distributions — Python 3.11.17 documentation

Navigation index modules | next | previous | Python » 3.11.17 Documentation » Distributing Python Modules (Legacy version) » 5. Creating Built Distributions | Theme | 5. Creating Built Distributions ¶ Note This document is being retained solely until the setuptools documentation at https://setuptools.readthedocs.io/en/latest/setuptools.html independently covers all of the relevant information currently included here.

A “built distribution” is what you’re probably used to thinking of either as a “binary package” or an “installer” (depending on your background). It’s not necessarily binary, though, because it might contain only Python source code and/or byte-code; and we don’t call it a package, because that word is already spoken for in Python. (And “installer” is a term specific to the world of mainstream desktop systems.) A built distribution is how you make life as easy as possible for installers of your module distribution: for users of RPM-based Linux systems, it’s a binary RPM; for Windows users, it’s an executable installer; for Debian-based Linux users, it’s a Debian package; and so forth.

Obviously, no one person will be able to create built distributions for every platform under the sun, so the Distutils are designed to enable module developers to concentrate on their specialty—writing code and creating source distributions—while an intermediary species called packagers springs up to turn source distributions into built distributions for as many platforms as there are packagers. Of course, the module developer could be their own packager; or the packager could be a volunteer “out there” somewhere who has access to a platform which the original developer does not; or it could be software periodically grabbing new source distributions and turning them into built distributions for as many platforms as the software has access to.

Regardless of who they are, a packager uses the setup script and the bdist command family to generate built distributions. As a simple example, if I run the following command in the Distutils source tree: python setup . py bdist then the Distutils builds my module distribution (the Distutils itself in this case), does a “fake” installation (also in the build directory), and creates the default type of built distribution for my platform.

The default format for built distributions is a “dumb” tar file on Unix, and a simple executable installer on Windows. (That tar file is considered “dumb” because it has to be unpacked in a specific location to work.) Thus, the above command on a Unix system creates Distutils-1.0. plat .tar.gz ; unpacking this tarball from the right place installs the Distutils just as though you had downloaded the source distribution and run python setup.py install . (The “right place” is either the root of the filesystem or Python’s prefix directory, depending on the options given to the bdist_dumb command; the default is to make dumb distributions relative to prefix .) Obviously, for pure Python distributions, this isn’t any simpler than just running python setup.py install —but for non-pure distributions, which include extensions that would need to be compiled, it can mean the difference between someone being able to use your extensions or not.

And creating “smart” built distributions, such as an RPM package or an executable installer for Windows, is far more convenient for users even if your distribution doesn’t include any extensions. The bdist command has a --formats option, similar to the sdist command, which you can use to select the types of built distribution to generate: for example, python setup . py bdist -- format = zip would, when run on a Unix system, create Distutils-1.0. plat .zip —again, this archive would be unpacked from the root directory to install the Distutils.

The available formats for built distributions are: Format Description Notes gztar gzipped tar file ( .tar.gz ) (1) bztar bzipped tar file ( .tar.bz2 ) xztar xzipped tar file ( .tar.xz ) ztar compressed tar file ( .tar.Z ) (3) tar tar file ( .tar ) zip zip file ( .zip ) (2),(4) rpm RPM (5) pkgtool Solaris pkgtool sdux HP-UX swinstall msi Microsoft Installer. Changed in version 3.5: Added support for the xztar format. Notes: default on Unix default on Windows requires external compress utility. requires either external zip utility or zipfile module (part of the standard Python library since Python 1.6) requires external rpm utility, version 3.0.4 or better (use rpm --version to find out which version you have) You don’t have to use the bdist command with the --formats option; you can also use the command that directly implements the format you’re interested in.

Some of these bdist “sub-commands” actually generate several similar formats; for instance, the bdist_dumb command generates all the “dumb” archive formats ( tar , gztar , bztar , xztar , ztar , and zip ), and bdist_rpm generates both binary and source RPMs. The bdist sub-commands, and the formats generated by each, are: Command Formats bdist_dumb tar, gztar, bztar, xztar, ztar, zip bdist_rpm rpm, srpm The following sections give details on the individual bdist_* commands.

5.1. Creating RPM packages ¶ The RPM format is used by many popular Linux distributions, including Red Hat, SuSE, and Mandrake. If one of these (or any of the other RPM-based Linux distributions) is your usual environment, creating RPM packages for other users of that same distribution is trivial. Depending on the complexity of your module distribution and differences between Linux distributions, you may also be able to create RPMs that work on different RPM-based distributions.

The usual way to create an RPM of your module distribution is to run the bdist_rpm command: python setup . py bdist_rpm or the bdist command with the --format option: python setup . py bdist -- formats = rpm The former allows you to specify RPM-specific options; the latter allows you to easily specify multiple formats in one run. If you need to do both, you can explicitly specify multiple bdist_* commands and their options: python setup . py bdist_rpm -- packager = "John Doe <jdoe@example.org>" Creating RPM packages is driven by a .spec file, much as using the Distutils is driven by the setup script.

To make your life easier, the bdist_rpm command normally creates a .spec file based on the information you supply in the setup script, on the command line, and in any Distutils configuration files. Various options and sections in the .spec file are derived from options in the setup script as follows: RPM .spec file option or section Distutils setup script option Name name Summary (in preamble) description Version version Vendor author and author_email , or — & maintainer and maintainer_email Copyright license Url url %description (section) long_description Additionally, there are many options in .spec files that don’t have corresponding options in the setup script.

Most of these are handled through options to the bdist_rpm command as follows: RPM .spec file option or section bdist_rpm option default value Release release “1” Group group “Development/Libraries” Vendor vendor (see above) Packager packager (none) Provides provides (none) Requires requires (none) Conflicts conflicts (none) Obsoletes obsoletes (none) Distribution distribution_name (none) BuildRequires build_requires (none) Icon icon (none) Obviously, supplying even a few of these options on the command-line would be tedious and error-prone, so it’s usually best to put them in the setup configuration file, setup.cfg —see section Writing the Setup Configuration File .

If you distribute or package many Python module distributions, you might want to put options that apply to all of them in your personal Distutils configuration file ( ~/.pydistutils.cfg ). If you want to temporarily disable this file, you can pass the --no-user-cfg option to setup.py . There are three ste

The rest of this page is on the live site.