Skip to content

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

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.

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

Merged
merged 6 commits into from
Apr 13, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
8 changes: 8 additions & 0 deletions docs/html/user_guide.rst
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 @@ -248,6 +252,10 @@ 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.
http://example.com/constraints.txt, so that your organization can store and
serve them in a centralized place.

.. _`Installing from Wheels`:


Expand Down
1 change: 1 addition & 0 deletions news/11954.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Make it clear that constraints file can be a URL