Go to file
Vinay Sajip 8ed03aab48 Bump version. 2021-12-08 17:04:40 +00:00
.github/workflows Update test verbosity, tweak CI triggers. 2021-12-05 15:00:11 +00:00
PC Update launchers to ignore handle-duplication errors in GUI launchers. 2021-11-17 18:59:20 +00:00
distlib Bump version. 2021-12-08 17:04:40 +00:00
docs Add release number to documentation. 2021-09-22 08:45:28 +01:00
tests Remove/change some more obsolete code paths. 2021-12-08 10:02:48 +00:00
.coveragerc Updated change log and tweaked coverage config. 2015-03-20 09:22:00 +00:00
.gitignore Added .gitignore. 2019-11-16 08:56:56 +00:00
.hgignore Remove/change some more obsolete code paths. 2021-12-08 10:02:48 +00:00
.hgtags Added tag 0.3.4 for changeset b55294aa7e97 2021-12-08 16:25:52 +00:00
.readthedocs.yml Updated ReadTheDocs configuration. 2019-10-30 09:07:53 +00:00
.travis.yml Update Travis configuration. 2021-02-05 11:20:58 +00:00
CHANGES.rst Changes for 0.3.4. 2021-12-08 11:30:02 +00:00
CONTRIBUTORS.txt Use resources rather than direct file access. 2013-07-23 05:20:44 -05:00
LICENSE.txt Added LICENSE.txt and CONTRIBUTORS.txt, updated copyright notices. 2012-09-28 10:00:16 +01:00
MANIFEST.in Remove 2.6-specific stuff. 2021-12-08 08:42:23 +00:00
README.rst Update badge URL. 2021-05-29 11:32:20 +01:00
appveyor.yml Remove Python 3.9 from AppVeyor configuration. 2021-01-12 21:41:58 +00:00
setup.py Remove 2.6-specific stuff. 2021-12-08 08:42:23 +00:00
tox.ini Remove 2.6-specific stuff. 2021-12-08 08:42:23 +00:00

README.rst

AppVeyor

image

What is it?

Distlib is a library which implements low-level functions that relate to packaging and distribution of Python software. It is intended to be used as the basis for third-party packaging tools. The documentation is available at

https://distlib.readthedocs.io/

Main features

Distlib currently offers the following features:

  • The package distlib.database, which implements a database of installed distributions, as defined by 376, and distribution dependency graph logic. Support is also provided for non-installed distributions (i.e. distributions registered with metadata on an index like PyPI), including the ability to scan for dependencies and building dependency graphs.
  • The package distlib.index, which implements an interface to perform operations on an index, such as registering a project, uploading a distribution or uploading documentation. Support is included for verifying SSL connections (with domain matching) and signing/verifying packages using GnuPG.
  • The package distlib.metadata, which implements distribution metadata as defined by 426, 345, 314 and 241.
  • The package distlib.markers, which implements environment markers as defined by 426.
  • The package distlib.manifest, which implements lists of files used in packaging source distributions.
  • The package distlib.locators, which allows finding distributions, whether on PyPI (XML-RPC or via the "simple" interface), local directories or some other source.
  • The package distlib.resources, which allows access to data files stored in Python packages, both in the file system and in .zip files.
  • The package distlib.scripts, which allows installing of scripts with adjustment of shebang lines and support for native Windows executable launchers.
  • The package distlib.version, which implements version specifiers as defined by 440 / 426, but also support for working with "legacy" versions (setuptools/distribute) and semantic versions.
  • The package distlib.wheel, which provides support for building and installing from the Wheel format for binary distributions (see 427).
  • The package distlib.util, which contains miscellaneous functions and classes which are useful in packaging, but which do not fit neatly into one of the other packages in distlib.* The package implements enhanced globbing functionality such as the ability to use ** in patterns to specify recursing into subdirectories.

Python version and platform compatibility

Distlib is intended to be used on any Python version >= 2.7 and is tested on Python versions 2.7 and 3.3-3.6 on Linux, Windows, and Mac OS X (not all versions are tested on all platforms, but are expected to work correctly).

Project status

The project has reached a mature status in its development: there is a test suite and it has been exercised on Windows, Ubuntu and Mac OS X. The project is used by well-known projects such as pip and caniusepython3.

Code of Conduct

Everyone interacting in the distlib project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.