27.15. packaging — Packaging support

The packaging package provides support for building, packaging, distributing and installing additional projects into a Python installation. Projects may include Python modules, extension modules, packages and scripts. packaging also provides building blocks for other packaging systems that are not tied to the command system.

This manual is the reference documentation for those standalone building blocks and for extending Packaging. If you’re looking for the user-centric guides to install a project or package your own code, head to See also.

27.15.1. Building blocks

• 27.15.1.1. packaging.errors — Packaging exceptions
• 27.15.1.2. packaging.manifest — The Manifest class
• 27.15.1.3. packaging.version — Version number classes
  • 27.15.1.3.1. Version numbers
  • 27.15.1.3.2. Version predicates
  • 27.15.1.3.3. Validation helpers
• 27.15.1.4. packaging.metadata — Metadata handling
  • 27.15.1.4.1. Reading metadata
  • 27.15.1.4.2. Writing metadata
  • 27.15.1.4.3. Conflict checking and best version
• 27.15.1.5. packaging.markers — Environment markers
• 27.15.1.6. packaging.database — Database of installed distributions
  • 27.15.1.6.1. Classes representing installed distributions
  • 27.15.1.6.2. Functions to work with the database
  • 27.15.1.6.3. Utility functions
  • 27.15.1.6.4. Examples
• 27.15.1.7. packaging.depgraph — Dependency graph builder
  • 27.15.1.7.1. The DependencyGraph class
  • 27.15.1.7.2. Auxiliary functions
  • 27.15.1.7.3. Example Usage
• 27.15.1.8. packaging.pypi — Interface to projects indexes
• 27.15.1.9. packaging.pypi.client — High-level query API
• 27.15.1.10. packaging.pypi.base — Base class for index crawlers
• 27.15.1.11. packaging.pypi.dist — Classes representing query results
  • 27.15.1.11.1. ReleaseInfo
  • 27.15.1.11.2. DistInfo
  • 27.15.1.11.3. ReleasesList
  • 27.15.1.11.4. Example usage
• 27.15.1.12. packaging.pypi.simple — Crawler using the PyPI “simple” interface
  • 27.15.1.12.1. API
  • 27.15.1.12.2. Usage Examples
• 27.15.1.13. packaging.pypi.xmlrpc — Crawler using the PyPI XML-RPC interface
  • 27.15.1.13.1. API
  • 27.15.1.13.2. Usage examples
• 27.15.1.14. packaging.install — Installation tools
  • 27.15.1.14.1. Public functions

27.15.2. The command machinery

• 27.15.2.1. packaging.dist — The Distribution class
• 27.15.2.2. packaging.command — Standard Packaging commands
• 27.15.2.3. packaging.command.cmd — Abstract base class for Packaging commands
  • 27.15.2.3.1. Creating a new Packaging command
• 27.15.2.4. packaging.compiler — Compiler classes
  • 27.15.2.4.1. Public functions
  • 27.15.2.4.2. Standard compilers
• 27.15.2.5. packaging.compiler.ccompiler — CCompiler base class
• 27.15.2.6. packaging.compiler.extension — The Extension class
• 27.15.2.7. packaging.fancy_getopt — Wrapper around the getopt module

27.15.3. Other utilities

• 27.15.3.1. packaging.util — Miscellaneous utility functions
• 27.15.3.2. packaging.tests.pypi_server — PyPI mock server
  • 27.15.3.2.1. The mock server
  • 27.15.3.2.2. Base class and decorator for tests

See also

Distributing Python Projects

The manual for developers of Python projects who want to package and distribute them. This describes how to use packaging to make projects easily found and added to an existing Python installation.

Installing Python Projects

A user-centered manual which includes information on adding projects into an existing Python installation. You do not need to be a Python programmer to read this manual.