Distributing Python Modules (Legacy version)
- Authors
Greg Ward, Anthony Baxter
See also
- Distributing Python Modules
The up to date module distribution documentations
This document describes the Python Distribution Utilities (Distutils) from the module developers point of view, describing how to use the Distutils to make Python modules and extensions easily available to a wider audience with very little overhead for build/release/install mechanics.
Note
This guide only covers the basic tools for building and distributing extensions that are provided as part of this version of Python. Third party tools offer easier to use and more secure alternatives. Refer to the quick recommendations section in the Python Packaging User Guide for more information.
- 1. An Introduction to Distutils
- 2. Writing the Setup Script
- 3. Writing the Setup Configuration File
- 4. Creating a Source Distribution
- 5. Creating Built Distributions
- 6. The Python Package Index (PyPI)
- 7. Examples
- 8. Extending Distutils
- 9. Command Reference
- 10. API Reference
- 10.1.
distutils.coreCore Distutils functionality - 10.2.
distutils.ccompilerCCompiler base class - 10.3.
distutils.unixccompilerUnix C Compiler - 10.4.
distutils.msvccompilerMicrosoft Compiler - 10.5.
distutils.bcppcompilerBorland Compiler - 10.6.
distutils.cygwincompilerCygwin Compiler - 10.7.
distutils.archive_utilArchiving utilities - 10.8.
distutils.dep_utilDependency checking - 10.9.
distutils.dir_utilDirectory tree operations - 10.10.
distutils.file_utilSingle file operations - 10.11.
distutils.utilMiscellaneous other utility functions - 10.12.
distutils.distThe Distribution class - 10.13.
distutils.extensionThe Extension class - 10.14.
distutils.debugDistutils debug mode - 10.15.
distutils.errorsDistutils exceptions - 10.16.
distutils.fancy_getoptWrapper around the standard getopt module - 10.17.
distutils.filelistThe FileList class - 10.18.
distutils.logSimple PEP 282-style logging - 10.19.
distutils.spawnSpawn a sub-process - 10.20.
distutils.sysconfigSystem configuration information - 10.21.
distutils.text_fileThe TextFile class - 10.22.
distutils.versionVersion number classes - 10.23.
distutils.cmdAbstract base class for Distutils commands - 10.24. Creating a new Distutils command
- 10.25.
distutils.commandIndividual Distutils commands - 10.26.
distutils.command.bdistBuild a binary installer - 10.27.
distutils.command.bdist_packagerAbstract base class for packagers - 10.28.
distutils.command.bdist_dumbBuild a dumb installer - 10.29.
distutils.command.bdist_msiBuild a Microsoft Installer binary package - 10.30.
distutils.command.bdist_rpmBuild a binary distribution as a Redhat RPM and SRPM - 10.31.
distutils.command.bdist_wininstBuild a Windows installer - 10.32.
distutils.command.sdistBuild a source distribution - 10.33.
distutils.command.buildBuild all files of a package - 10.34.
distutils.command.build_clibBuild any C libraries in a package - 10.35.
distutils.command.build_extBuild any extensions in a package - 10.36.
distutils.command.build_pyBuild the .py/.pyc files of a package - 10.37.
distutils.command.build_scriptsBuild the scripts of a package - 10.38.
distutils.command.cleanClean a package build area - 10.39.
distutils.command.configPerform package configuration - 10.40.
distutils.command.installInstall a package - 10.41.
distutils.command.install_dataInstall data files from a package - 10.42.
distutils.command.install_headersInstall C/C++ header files from a package - 10.43.
distutils.command.install_libInstall library files from a package - 10.44.
distutils.command.install_scriptsInstall script files from a package - 10.45.
distutils.command.registerRegister a module with the Python Package Index - 10.46.
distutils.command.checkCheck the meta-data of a package
- 10.1.