From 57191793579e893c584485676c08173e35a8bcaf Mon Sep 17 00:00:00 2001 From: Honnix Date: Wed, 12 Apr 2023 22:55:18 +0200 Subject: Make it clear that constraints file can be a URL --- docs/html/user_guide.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 966b200f4..d92197a76 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -242,6 +242,10 @@ 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, -- cgit v1.2.1 From b62076fd5ff27ff1a3c436264379828fd2d59e30 Mon Sep 17 00:00:00 2001 From: Honnix Date: Wed, 12 Apr 2023 23:02:11 +0200 Subject: Create 11954.doc.rst --- news/11954.doc.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 news/11954.doc.rst diff --git a/news/11954.doc.rst b/news/11954.doc.rst new file mode 100644 index 000000000..043dfaaa6 --- /dev/null +++ b/news/11954.doc.rst @@ -0,0 +1 @@ +Make it clear that constraints file can be a URL -- cgit v1.2.1 From beb97187abb8a4ed3debedcc9fc804618d85a4fd Mon Sep 17 00:00:00 2001 From: Honnix Date: Thu, 13 Apr 2023 09:02:27 +0200 Subject: Update user_guide.rst --- docs/html/user_guide.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index d92197a76..7175675ba 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -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 @@ -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. +http://example.com/constraints.txt, so that your organization can store and +serve them in a centralized place. + .. _`Installing from Wheels`: -- cgit v1.2.1 From f9e9a016d7893d2e1098c846abb536ee4bd71468 Mon Sep 17 00:00:00 2001 From: Honnix Date: Thu, 13 Apr 2023 09:05:10 +0200 Subject: Update user_guide.rst --- docs/html/user_guide.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 7175675ba..3bb9e88ad 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -252,8 +252,8 @@ 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 +The same as requirements files, constraints files can also 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`: -- cgit v1.2.1 From 40e56a750606e8221521f85e84560d029c90eb2b Mon Sep 17 00:00:00 2001 From: Honnix Date: Thu, 13 Apr 2023 09:14:50 +0200 Subject: Update 11954.doc.rst --- news/11954.doc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/news/11954.doc.rst b/news/11954.doc.rst index 043dfaaa6..946b4057f 100644 --- a/news/11954.doc.rst +++ b/news/11954.doc.rst @@ -1 +1 @@ -Make it clear that constraints file can be a URL +Make it clear that requirements/constraints file can be a URL -- cgit v1.2.1 From d914ffa92700e938ebc5327683605606dfdfacf1 Mon Sep 17 00:00:00 2001 From: Honnix Date: Thu, 13 Apr 2023 09:15:42 +0200 Subject: Update user_guide.rst --- docs/html/user_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 3bb9e88ad..9a6f2901c 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -252,7 +252,7 @@ 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 also be served via a URL, +Same as requirements files, constraints files can also 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. -- cgit v1.2.1