Distributing Python Modules
Greg Ward
Anthony Baxter
Python Software Foundation
Email: [email protected]
Release 2.4b2
13 November 2004
Abstract:
This document describes the Python Distribution Utilities
(``Distutils'') from the module developer's 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.
- 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. Registering with the Package Index
- 7. Examples
- 8. Extending Distutils
- 9. Command Reference
- 10. API Reference
- 10.1 distutils.core -- Core Distutils functionality
- 10.2 distutils.ccompiler -- CCompiler base class
- 10.3 distutils.unixccompiler -- Unix C Compiler
- 10.4 distutils.msvccompiler -- Microsoft Compiler
- 10.5 distutils.bcppcompiler -- Borland Compiler
- 10.6 distutils.cygwincompiler -- Cygwin Compiler
- 10.7 distutils.emxccompiler -- OS/2 EMX Compiler
- 10.8 distutils.mwerkscompiler -- Metrowerks CodeWarrior support
- 10.9 distutils.archive_util -- Archiving utilities
- 10.10 distutils.dep_util -- Dependency checking
- 10.11 distutils.dir_util -- Directory tree operations
- 10.12 distutils.file_util -- Single file operations
- 10.13 distutils.util -- Miscellaneous other utility functions
- 10.14 distutils.dist -- The Distribution class
- 10.15 distutils.extension -- The Extension class
- 10.16 distutils.debug -- Distutils debug mode
- 10.17 distutils.errors -- Distutils exceptions
- 10.18 distutils.fancy_getopt -- Wrapper around the standard getopt module
- 10.19 distutils.filelist -- The FileList class
- 10.20 distutils.log -- Simple PEP 282-style logging
- 10.21 distutils.spawn -- Spawn a sub-process
- 10.22 distutils.sysconfig -- System configuration information
- 10.23 distutils.text_file -- The TextFile class
- 10.24 distutils.version -- Version number classes
- 10.25 distutils.cmd -- Abstract base class for Distutils commands
- 10.26 distutils.command -- Individual Distutils commands
- 10.27 distutils.command.bdist -- Build a binary installer
- 10.28 distutils.command.bdist_packager -- Abstract base class for packagers
- 10.29 distutils.command.bdist_dumb -- Build a ``dumb'' installer
- 10.30 distutils.command.bdist_rpm -- Build a binary distribution as a Redhat RPM and SRPM
- 10.31 distutils.command.bdist_wininst -- Build a Windows installer
- 10.32 distutils.command.sdist -- Build a source distribution
- 10.33 distutils.command.build -- Build all files of a package
- 10.34 distutils.command.build_clib -- Build any C libraries in a package
- 10.35 distutils.command.build_ext -- Build any extensions in a package
- 10.36 distutils.command.build_py -- Build the .py/.pyc files of a package
- 10.37 distutils.command.build_scripts -- Build the scripts of a package
- 10.38 distutils.command.clean -- Clean a package build area
- 10.39 distutils.command.config -- Perform package configuration
- 10.40 distutils.command.install -- Install a package
- 10.41 distutils.command.install_data -- Install data files from a package
- 10.42 distutils.command.install_headers -- Install C/C++ header files from a package
- 10.43 distutils.command.install_lib -- Install library files from a package
- 10.44 distutils.command.install_scripts -- Install script files from a package
- 10.45 distutils.command.register -- Register a module with the Python Package Index
- 10.46 Creating a new Distutils command
- Module Index
- Index
- About this document ...
Release 2.4b2, documentation updated on 13 November 2004.