McSinyx
/
pip
mirror of https://github.com/pypa/pip
1
1
Fork 0
Code Issues Releases Activity

Tweak requirement file documentation. 

We're actually pinning down a fairly specific grammar now, so lets
make it official. All options are at the end, and only options get
quoting. I've also tweaked some of the existing examples to make the
existing grammar features (that I know people use) clearer - like
spaces between requirements and version specifiers.
This commit is contained in:
Robert Collins 2015-06-02 07:09:53 +12:00
parent ab2ec7f85b
commit 1d04615a37
2 changed files with 22 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CHANGES.txt
View File

@ -2,8 +2,13 @@
**7.0.2 (unreleased)**
* Revert the change (released in v7.0.0) that required quoting in requirements
files around specifiers containing environment markers.
* **BACKWARD INCOMPATIBLE** Revert the change (released in v7.0.0) that
required quoting in requirements files around specifiers containing
environment markers. (:pull:`2841`)
* **BACKWARD INCOMPATIBLE** Revert the accidental introduction of support for
options interleaved with requirements, version specifiers etc in
``requirements`` files. (:pull:`2841`)
**7.0.1 (2015-05-22)**

27
docs/reference/pip_install.rst
View File

@ -82,7 +82,8 @@ Requirements File Format
Each line of the requirements file indicates something to be installed,
and like arguments to :ref:`pip install`, the following forms are supported::
<requirement specifier> [--install-option="..."] [--global-option="..."]
[[--option]...]
<requirement specifier> [; markers] [[--option]...]
<archive url/path>
[-e] <local project path>
[-e] <vcs project url>
@ -130,19 +131,19 @@ Requirement Specifiers
pip supports installing from a package index using a :term:`requirement
specifier <pypug:Requirement Specifier>`. Generally speaking, a requirement
specifier is composed of a project name followed by an optional :term:`version
specifier <pypug:Version Specifier>`. :ref:`PEP440 <pypa:PEP440s>` contains a
`full specification
specifier is composed of a project name followed by optional :term:`version
specifiers <pypug:Version Specifier>`. :ref:`PEP440 <pypa:PEP440s>` contains
a `full specification
<https://www.python.org/dev/peps/pep-0440/#version-specifiers>`_ of the
currently supported specifiers.
Below are some examples:
Some examples:
::
SomeProject
SomeProject==1.3
SomeProject>=1.2,<.2.0
SomeProject == 1.3
SomeProject >=1.2,<.2.0
SomeProject[foo, bar]
SomeProject~=1.4.2
@ -151,7 +152,7 @@ Since version 6.0, pip also supports specifers containing `environment markers
::
SomeProject; python_version < '2.7'
SomeProject ==5.4 ; python_version < '2.7'
SomeProject; sys.platform == 'win32'
Environment markers are supported in the command line and in requirements files.
@ -167,10 +168,12 @@ Environment markers are supported in the command line and in requirements files.
Per-requirement Overrides
+++++++++++++++++++++++++
When pip installs packages, it normally executes the ``setup.py`` file
behind the scenes. You may extend the arguments with which the
``setup.py`` file is called through the ``--global-option`` and
``--install-option`` options. For example:
Since version 7.0 pip supports controlling the command line options given to
``setup.py`` via requirements files. This disables the use of wheels (cached or
otherwise) for that package, as ``setup.py`` does not exist for wheels.
The ``--global-option`` and ``--install-option`` options are used to pass
options to ``setup.py``. For example:
::