Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: Make it clear that requirements/constraints file can be a URL #11954

Merged
merged 6 commits into from
Apr 13, 2023
Merged

doc: Make it clear that requirements/constraints file can be a URL #11954

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5719179
Make it clear that constraints file can be a URL
honnix Apr 12, 2023
b62076f
Create 11954.doc.rst
honnix Apr 12, 2023
beb9718
Update user_guide.rst
honnix Apr 13, 2023
f9e9a01
Update user_guide.rst
honnix Apr 13, 2023
40e56a7
Update 11954.doc.rst
honnix Apr 13, 2023
d914ffa
Update user_guide.rst
honnix Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/html/user_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,10 @@ Logically, a Requirements file is just a list of :ref:`pip install` arguments
placed in a file. Note that you should not rely on the items in the file being
installed by pip in any particular order.

Requirements files can also be served via a URL, e.g.
http://example.com/requirements.txt besides as local files, so that they can
be stored and served in a centralized place.

In practice, there are 4 common uses of Requirements files:

1. Requirements files are used to hold the result from :ref:`pip freeze` for the
Expand Down Expand Up @@ -242,16 +246,16 @@ organisation and use that everywhere. If the thing being installed requires
"helloworld" to be installed, your fixed version specified in your constraints
file will be used.

Constraints file can be served via a URL, e.g.
http://example.com/constraints.txt instead of only a local file, so that your
organization can provide constraints files online from a centraliazed place.

Constraints file support was added in pip 7.1. In :ref:`Resolver
changes 2020` we did a fairly comprehensive overhaul, removing several
undocumented and unsupported quirks from the previous implementation,
and stripped constraints files down to being purely a way to specify
global (version) limits for packages.

The same as requirements files, constraints files can be served via a URL, e.g.
uranusjr marked this conversation as resolved.
Show resolved Hide resolved
http://example.com/constraints.txt, so that your organization can store and
serve them in a centralized place.

.. _`Installing from Wheels`:


Expand Down