Welcome to distlib’s documentation!

Release:	0.3.9.dev0

Welcome to the documentation for distlib, a library of packaging functionality which is intended to be used as the basis for third-party packaging tools. Using a common layer will improve interoperability and consistency of user experience across those tools which use the library.

Please note: this documentation is a work in progress.

• Overview
  • Distlib evolved out of packaging
  • What was the problem with packaging?
  • How Distlib can help
  • How you can help
  • Main features
  • Python version and platform compatibility
  • Project status
  • Change log for distlib
    • 0.3.9 (future)
    • 0.3.8
    • 0.3.7
    • 0.3.6
    • 0.3.5
    • 0.3.4
    • 0.3.3
    • 0.3.2
    • 0.3.1
    • 0.3.0
    • 0.2.9
    • 0.2.8
    • 0.2.7
    • 0.2.6
    • 0.2.5
    • 0.2.4
    • 0.2.3
    • 0.2.2
    • 0.2.1
    • 0.2.0
    • 0.1.9
    • 0.1.8
    • 0.1.7
    • 0.1.6
    • 0.1.5
    • 0.1.4
    • 0.1.3
    • 0.1.2
    • 0.1.1
    • 0.1.0
  • Next steps
• Tutorial
  • Installation
  • Testing
    • PYPI availability
  • First steps
    • Using the database API
      • Distribution paths
      • Querying a path for distributions
      • Including legacy distributions in the search results
      • Distribution properties
      • Exporting things from Distributions
    • Distribution dependencies
    • Using the locators API
      • Overview
      • Under the hood
    • Using the index API
      • Overview
      • Registering a project
      • Uploading a source distribution
      • Uploading binary distributions
      • Signing a distribution
      • Downloading files
      • Verifying signatures
      • Uploading documentation
      • Authentication
      • Verifying HTTPS connections
      • Saving a default configuration
      • Searching PyPI
    • Using the metadata and markers APIs
      • Instantiating metadata
      • Reading metadata from files and streams
      • Writing metadata to paths and streams
      • Using markers
    • Using the resource API
      • Access to resources in the file system
      • Access to resources in the .zip files
      • Iterating over resources
    • Using the scripts API
      • Specifying scripts to install
      • Wrapping callables with scripts
      • Specifying a custom executable for shebangs
      • Generating variants of a script
      • Avoiding overwriting existing scripts
      • Generating windowed scripts on Windows
    • Using the version API
      • Overview
      • Matching versions against constraints
    • Using the wheel API
      • Building wheels
      • Customising tags during build
      • Specifying a wheel’s version
      • Installing from wheels
      • Verifying wheels
      • Modifying wheels
      • Mounting wheels
      • Using vanilla pip to build wheels for existing distributions on PyPI
    • Using the manifest API
      • The include directive
      • The exclude directive
      • The global-include directive
      • The global-exclude directive
      • The recursive-include directive
      • The recursive-exclude directive
      • The graft directive
      • The prune directive
  • Next steps
• Distlib’s design
  • The locators API
    • The problem we’re trying to solve
    • A minimal solution
      • Locating distributions
      • Finding dependencies
  • The index API
    • The problem we’re trying to solve
    • A minimal solution
  • The resources API
    • The problem we’re trying to solve
    • A minimal solution
    • Dealing with the requirement for access via file system files
  • The scripts API
    • The problem we’re trying to solve
    • A minimal solution
      • Flag formats
  • The version API
    • The problem we’re trying to solve
    • A minimal solution
      • Versions
      • Matchers
      • Version schemes
  • The wheel API
    • The problem we’re trying to solve
    • A minimal solution
  • Next steps
• API Reference
  • The distlib package
    • Classes
      • DistlibException
  • The distlib.database package
    • Classes
      • DistributionPath
      • Distribution
      • InstalledDistribution
      • EggInfoDistribution
      • DependencyGraph
    • Functions
      • make_graph()
      • get_dependent_dists()
      • get_required_dists()
  • The distlib.resources package
    • Attributes
      • cache
    • Functions
      • finder()
      • register_finder()
    • Classes
      • Resource
      • ResourceFinder
      • ZipResourceFinder
      • ResourceCache
  • The distlib.scripts package
    • Classes
      • ScriptMaker
    • Functions
      • enquote_executable()
  • The distlib.locators package
    • Classes
      • Locator
      • DirectoryLocator
      • PyPIRPCLocator
      • PyPIJSONLocator
      • SimpleScrapingLocator
      • DistPathLocator
      • AggregatingLocator
      • DependencyFinder
    • Functions
      • get_all_distribution_names()
      • locate()
    • Variables
      • default_locator
  • The distlib.index package
    • Classes
      • PackageIndex
  • The distlib.util package
    • Classes
      • Cache
      • ExportEntry
      • HTTPSHandler
      • HTTPSOnlyHandler
    • Functions
      • get_cache_base()
      • path_to_cache_dir()
      • get_export_entry()
      • resolve()
  • The distlib.wheel package
    • Attributes
      • cache
      • COMPATIBLE_TAGS
    • Classes
      • Wheel
    • Functions
      • is_compatible()
  • The distlib.versions package
    • Classes
      • Version
      • Matcher
      • VersionScheme
      • NormalizedVersion
      • NormalizedMatcher
    • Functions
      • get_scheme()
  • The distlib.manifest package
    • Classes
      • Manifest
  • The distlib.metadata package
    • Classes
      • Metadata
  • The distlib.markers package
    • Functions
      • interpret()
  • Next steps
• Migrating from older APIs
  • The pkg_resources resource API
    • Basic resource access
    • Resource extraction
    • Provider interface
  • The pkg_resources entry point API