27.16.1. Distributing Python Modules

Authors:Greg Ward, Anthony Baxter Email:distutils-sig@python.org Release:3.3 Date:February 14, 2012

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.

Deprecated since version 3.3: packaging replaces Distutils. See Distributing Python Projects and Installing Python Projects.

• 27.16.1.1. An Introduction to Distutils
  • 27.16.1.1.1. Concepts & Terminology
  • 27.16.1.1.2. A Simple Example
  • 27.16.1.1.3. General Python terminology
  • 27.16.1.1.4. Distutils-specific terminology
• 27.16.1.2. Writing the Setup Script
  • 27.16.1.2.1. Listing whole packages
  • 27.16.1.2.2. Listing individual modules
  • 27.16.1.2.3. Describing extension modules
  • 27.16.1.2.4. Relationships between Distributions and Packages
  • 27.16.1.2.5. Installing Scripts
  • 27.16.1.2.6. Installing Package Data
  • 27.16.1.2.7. Installing Additional Files
  • 27.16.1.2.8. Additional meta-data
  • 27.16.1.2.9. Debugging the setup script
• 27.16.1.3. Writing the Setup Configuration File
• 27.16.1.4. Creating a Source Distribution
  • 27.16.1.4.1. Specifying the files to distribute
  • 27.16.1.4.2. Manifest-related options
• 27.16.1.5. Creating Built Distributions
  • 27.16.1.5.1. Creating RPM packages
  • 27.16.1.5.2. Creating Windows Installers
  • 27.16.1.5.3. Cross-compiling on Windows
  • 27.16.1.5.4. Vista User Access Control (UAC)
• 27.16.1.6. Registering with the Package Index
  • 27.16.1.6.1. The .pypirc file
• 27.16.1.7. Uploading Packages to the Package Index
  • 27.16.1.7.1. PyPI package display
• 27.16.1.8. Examples
  • 27.16.1.8.1. Pure Python distribution (by module)
  • 27.16.1.8.2. Pure Python distribution (by package)
  • 27.16.1.8.3. Single extension module
  • 27.16.1.8.4. Checking a package
• 27.16.1.9. Extending Distutils
  • 27.16.1.9.1. Integrating new commands
  • 27.16.1.9.2. Adding new distribution types
• 27.16.1.10. Command Reference
  • 27.16.1.10.1. Installing modules: the install command family
  • 27.16.1.10.2. Creating a source distribution: the sdist command
• 27.16.1.11. API Reference
  • 27.16.1.11.1. distutils.core — Core Distutils functionality
  • 27.16.1.11.2. distutils.ccompiler — CCompiler base class
  • 27.16.1.11.3. distutils.unixccompiler — Unix C Compiler
  • 27.16.1.11.4. distutils.msvccompiler — Microsoft Compiler
  • 27.16.1.11.5. distutils.bcppcompiler — Borland Compiler
  • 27.16.1.11.6. distutils.cygwincompiler — Cygwin Compiler
  • 27.16.1.11.7. distutils.emxccompiler — OS/2 EMX Compiler
  • 27.16.1.11.8. distutils.archive_util — Archiving utilities
  • 27.16.1.11.9. distutils.dep_util — Dependency checking
  • 27.16.1.11.10. distutils.dir_util — Directory tree operations
  • 27.16.1.11.11. distutils.file_util — Single file operations
  • 27.16.1.11.12. distutils.util — Miscellaneous other utility functions
  • 27.16.1.11.13. distutils.dist — The Distribution class
  • 27.16.1.11.14. distutils.extension — The Extension class
  • 27.16.1.11.15. distutils.debug — Distutils debug mode
  • 27.16.1.11.16. distutils.errors — Distutils exceptions
  • 27.16.1.11.17. distutils.fancy_getopt — Wrapper around the standard getopt module
  • 27.16.1.11.18. distutils.filelist — The FileList class
  • 27.16.1.11.19. distutils.log — Simple PEP 282-style logging
  • 27.16.1.11.20. distutils.spawn — Spawn a sub-process
  • 27.16.1.11.21. distutils.sysconfig — System configuration information
  • 27.16.1.11.22. distutils.text_file — The TextFile class
  • 27.16.1.11.23. distutils.version — Version number classes
  • 27.16.1.11.24. distutils.cmd — Abstract base class for Distutils commands
  • 27.16.1.11.25. Creating a new Distutils command
  • 27.16.1.11.26. distutils.command — Individual Distutils commands
  • 27.16.1.11.27. distutils.command.bdist — Build a binary installer
  • 27.16.1.11.28. distutils.command.bdist_packager — Abstract base class for packagers
  • 27.16.1.11.29. distutils.command.bdist_dumb — Build a “dumb” installer
  • 27.16.1.11.30. distutils.command.bdist_msi — Build a Microsoft Installer binary package
  • 27.16.1.11.31. distutils.command.bdist_rpm — Build a binary distribution as a Redhat RPM and SRPM
  • 27.16.1.11.32. distutils.command.bdist_wininst — Build a Windows installer
  • 27.16.1.11.33. distutils.command.sdist — Build a source distribution
  • 27.16.1.11.34. distutils.command.build — Build all files of a package
  • 27.16.1.11.35. distutils.command.build_clib — Build any C libraries in a package
  • 27.16.1.11.36. distutils.command.build_ext — Build any extensions in a package
  • 27.16.1.11.37. distutils.command.build_py — Build the .py/.pyc files of a package
  • 27.16.1.11.38. distutils.command.build_scripts — Build the scripts of a package
  • 27.16.1.11.39. distutils.command.clean — Clean a package build area
  • 27.16.1.11.40. distutils.command.config — Perform package configuration
  • 27.16.1.11.41. distutils.command.install — Install a package
  • 27.16.1.11.42. distutils.command.install_data — Install data files from a package
  • 27.16.1.11.43. distutils.command.install_headers — Install C/C++ header files from a package
  • 27.16.1.11.44. distutils.command.install_lib — Install library files from a package
  • 27.16.1.11.45. distutils.command.install_scripts — Install script files from a package
  • 27.16.1.11.46. distutils.command.register — Register a module with the Python Package Index
  • 27.16.1.11.47. distutils.command.check — Check the meta-data of a package

Another document describes how to install modules and extensions packaged following the above guidelines:

• 27.16.1.12. Installing Python Modules
  • 27.16.1.12.1. Introduction
    • 27.16.1.12.1.1. Best case: trivial installation
    • 27.16.1.12.1.2. The new standard: Distutils
  • 27.16.1.12.2. Standard Build and Install
    • 27.16.1.12.2.1. Platform variations
    • 27.16.1.12.2.2. Splitting the job up
    • 27.16.1.12.2.3. How building works
    • 27.16.1.12.2.4. How installation works
  • 27.16.1.12.3. Alternate Installation
    • 27.16.1.12.3.1. Alternate installation: the user scheme
    • 27.16.1.12.3.2. Alternate installation: the home scheme
    • 27.16.1.12.3.3. Alternate installation: Unix (the prefix scheme)
    • 27.16.1.12.3.4. Alternate installation: Windows (the prefix scheme)
  • 27.16.1.12.4. Custom Installation
    • 27.16.1.12.4.1. Modifying Python’s Search Path
  • 27.16.1.12.5. Distutils Configuration Files
    • 27.16.1.12.5.1. Location and names of config files
    • 27.16.1.12.5.2. Syntax of config files
  • 27.16.1.12.6. Building Extensions: Tips and Tricks
    • 27.16.1.12.6.1. Tweaking compiler/linker flags
    • 27.16.1.12.6.2. Using non-Microsoft compilers on Windows
      • 27.16.1.12.6.2.1. Borland/CodeGear C++
      • 27.16.1.12.6.2.2. GNU C / Cygwin / MinGW
        • 27.16.1.12.6.2.2.1. Older Versions of Python and MinGW