This is the place where the functions and classes in distlib's public API are described.
The distlib.database package
This class represents a set of distributions which are installed on a Python path (like PYTHONPATH / sys.path). Both new-style (distlib) and legacy (egg) distributions are catered for.
A class representing a distribution, typically one which hasn't been installed (most likely, one which has been obtained from an index like PyPI).
A class representing an installed distribution. This class is not instantiated directly, except by packaging tools. Instances of it are returned from querying a :class:`DistributionPath`.
This class represents a dependency graph between releases. The nodes are distribution instances; the edges model dependencies. An edge from a to b means that a depends on b.
Direct access to the graph nodes and edges is provided through these attributes:
The distlib.resources package
A class representing resources. It is never instantiated directly, but always through calling a finder's find method.
A base class for resource finders, which finds resources for packages stored in the file system.
This has the same interface as :class:`ResourceFinder`.
This class implements a cache for resources which must be accessible as files in the file system. It is based on :class:`~distlib.util.Cache`, and adds resource-specific methods.
The distlib.scripts package
A class used to install scripts based on specifications.
The distlib.locators package
The base class for locators. Implements logic common to multiple locators.
This locator scans the file system under a base directory, looking for distribution archives. The locator scans all subdirectories recursively, unless the recursive flag is set to False.
This locator uses the PyPI XML-RPC interface to locate distribution archives and other data about downloads.
This locator uses the PyPI JSON interface to locate distribution archives and other data about downloads. It gets the metadata and URL information in a single call, so it should perform better than the XML-RPC locator.
This locator uses the PyPI 'simple' interface -- a Web scraping interface -- to locate distribution archives.
This locator uses a :class:`DistributionPath` instance to locate installed distributions.
This locator uses a list of other aggregators and delegates finding projects to them. It can either return the first result found (i.e. from the first aggregator in the list provided which returns a non-empty result), or a merged result from all the aggregators in the list.
This class allows you to recursively find all the distributions which a particular distribution depends on.
The distlib.index package
This class represents a package index which is compatible with PyPI, the Python Package Index. It allows you to register projects, upload source and binary distributions (with support for digital signatures), upload documentation, verify signatures and get a list of hosts which are mirrors for the index.
Initialise an instance, setting instance attributes named from the keyword arguments.
|param url:||The root URL for the index. If not specified, the URL for PyPI is used ('http://pypi.python.org/pypi').|
|The DNS name for a host which can be used to determine available mirror hosts for the index. If not specified, the value 'last.pypi.python.org' is used.|
The distlib.util package
This base class implements common operations for distlib caches.
A class holding information about a exports entry.
The distlib.wheel package
This package has functionality which allows you to work with wheels (see PEP 427).
This class represents wheels -- either existing wheels, or wheels to be built.
You might find it helpful to look at the mailing list.