| Page Status: | Complete |
|---|
| Last Reviewed: | 2015-09-08 |
|---|
.. glossary::
Binary Distribution
A specific kind of :term:`Built Distribution` that contains compiled
extensions.
Built Distribution
A :term:`Distribution <Distribution Package>` format containing files
and metadata that only need to be moved to the correct location on the
target system, to be installed. :term:`Wheel` is such a format, whereas
distutil's :term:`Source Distribution <Source Distribution (or
"sdist")>` is not, in that it requires a build step before it can be
installed. This format does not imply that python files have to be
precompiled (:term:`Wheel` intentionally does not include compiled
python files).
Distribution Package
A versioned archive file that contains Python :term:`packages <Import
Package>`, :term:`modules <module>`, and other resource files that are
used to distribute a :term:`Release`. The archive file is what an
end-user will download from the internet and install.
A distribution package is more commonly referred to with the single
words "package" or "distribution", but this guide may use the expanded
term when more clarity is needed to prevent confusion with an
:term:`Import Package` (which is also commonly called a "package") or
another kind of distribution (e.g. a Linux distribution or the Python
language distribution), which are often referred to with the single term
"distribution".
Egg
A :term:`Built Distribution` format introduced by :ref:`setuptools`,
which is being replaced by :term:`Wheel`. For details, see `The
Internal Structure of Python Eggs
<https://setuptools.readthedocs.io/en/latest/formats.html>`_ and
`Python Eggs <http://peak.telecommunity.com/DevCenter/PythonEggs>`_
Extension Module
A :term:`module` written in the low-level language of the Python implementation:
C/C++ for Python, Java for Jython. Typically contained in a single
dynamically loadable pre-compiled file, e.g. a shared object (.so) file
for Python extensions on Unix, a DLL (given the .pyd extension) for
Python extensions on Windows, or a Java class file for Jython
extensions.
Known Good Set (KGS)
A set of distributions at specified versions which are compatible with
each other. Typically a test suite will be run which passes all tests
before a specific set of packages is declared a known good set. This
term is commonly used by frameworks and toolkits which are comprised of
multiple individual distributions.
Import Package
A Python module which can contain other modules or recursively, other
packages.
An import package is more commonly referred to with the single word
"package", but this guide will use the expanded term when more clarity
is needed to prevent confusion with a :term:`Distribution Package` which
is also commonly called a "package".
Module
The basic unit of code reusability in Python, existing in one of two
types: :term:`Pure Module`, or :term:`Extension Module`.
Package Index
A repository of distributions with a web interface to automate
:term:`package <Distribution Package>` discovery and consumption.
Project
A library, framework, script, plugin, application, or collection of data
or other resources, or some combination thereof that is intended to be
packaged into a :term:`Distribution <Distribution Package>`.
Since most projects create :term:`Distributions <Distribution Package>`
using :ref:`distutils` or :ref:`setuptools`, another practical way to
define projects currently is something that contains a :term:`setup.py`
at the root of the project src directory, where "setup.py" is the
project specification filename used by :ref:`distutils` and
:ref:`setuptools`.
Python projects must have unique names, which are registered on
:term:`PyPI <Python Package Index (PyPI)>`. Each project will then
contain one or more :term:`Releases <Release>`, and each release may
comprise one or more :term:`distributions <Distribution Package>`.
Note that there is a strong convention to name a project after the name
of the package that is imported to run that project. However, this
doesn't have to hold true. It's possible to install a distribution from
the project 'foo' and have it provide a package importable only as
'bar'.
Pure Module
A :term:`module` written in Python and contained in a single .py file (and
possibly associated .pyc and/or .pyo files).
Python Packaging Authority (PyPA)
PyPA is a working group that maintains many of the relevant projects in
Python packaging. They maintain a site at https://www.pypa.io, host projects
on `github <https://github.com/pypa>`_ and `bitbucket
<https://bitbucket.org/pypa>`_, and discuss issues on the `pypa-dev
mailing list <https://groups.google.com/forum/#!forum/pypa-dev>`_.
Python Package Index (PyPI)
`PyPI <https://pypi.python.org/pypi>`_ is the default :term:`Package
Index` for the Python community. It is open to all Python developers to
consume and distribute their distributions.
Release
A snapshot of a :term:`Project` at a particular point in time, denoted
by a version identifier.
Making a release may entail the publishing of multiple
:term:`Distributions <Distribution Package>`. For example, if version
1.0 of a project was released, it could be available in both a source
distribution format and a Windows installer distribution format.
Requirement
A specification for a :term:`package <Distribution Package>` to be
installed. :ref:`pip`, the :term:`PYPA <Python Packaging Authority
(PyPA)>` recommended installer, allows various forms of specification
that can all be considered a "requirement". For more information, see the
:ref:`pip:pip install` reference.
Requirement Specifier
A format used by :ref:`pip` to install packages from a :term:`Package
Index`. For an EBNF diagram of the format, see the
`pkg_resources.Requirement
<https://setuptools.readthedocs.io/en/latest/pkg_resources.html#requirement-objects>`_
entry in the :ref:`setuptools` docs. For example, "foo>=1.3" is a
requirement specifier, where "foo" is the project name, and the ">=1.3"
portion is the :term:`Version Specifier`
Requirements File
A file containing a list of :term:`Requirements <Requirement>` that can
be installed using :ref:`pip`. For more information, see the :ref:`pip`
docs on :ref:`pip:Requirements Files`.
setup.py
The project specification file for :ref:`distutils` and :ref:`setuptools`.
Source Archive
An archive containing the raw source code for a :term:`Release`, prior
to creation of an :term:`Source Distribution <Source Distribution (or
"sdist")>` or :term:`Built Distribution`.
Source Distribution (or "sdist")
A :term:`distribution <Distribution Package>` format (usually generated
using ``python setup.py sdist``) that provides metadata and the
essential source files needed for installing by a tool like :ref:`pip`,
or for generating a :term:`Built Distribution`.
System Package
A package provided in a format native to the operating system,
e.g. an rpm or dpkg file.
Version Specifier
The version component of a :term:`Requirement Specifier`. For example,
the ">=1.3" portion of "foo>=1.3". :pep:`440` contains
a :pep:`full specification
<440#version-specifiers>` of the
specifiers that Python packaging currently supports. Support for PEP440
was implemented in :ref:`setuptools` v8.0 and :ref:`pip` v6.0.
Virtual Environment
An isolated Python environment that allows packages to be installed for
use by a particular application, rather than being installed system
wide. For more information, see the section on :ref:`Creating and using
Virtual Environments`.
Wheel
A :term:`Built Distribution` format introduced by :pep:`427`,
which is intended to replace the :term:`Egg` format. Wheel is currently
supported by :ref:`pip`.
Working Set
A collection of :term:`distributions <Distribution Package>` available
for importing. These are the distributions that are on the `sys.path`
variable. At most, one :term:`Distribution <Distribution Package>` for a
project is possible in a working set.