Skip to content

Commit 9a4e749

Browse files
committed
ngclient: Add docs on HTTP in general
Signed-off-by: Jussi Kukkonen <[email protected]>
1 parent 80b6290 commit 9a4e749

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

tuf/ngclient/updater.py

+13
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,19 @@
3535
A simple example of using the Updater to implement a Python TUF client that
3636
downloads target files is available in `examples/client
3737
<https://github.com/theupdateframework/python-tuf/tree/develop/examples/client>`_.
38+
39+
Notes on how Updater uses HTTP by default:
40+
* urllib3 is the HTTP library
41+
* Typically all requests are retried by urllib3 three times (in cases where
42+
this seems useful)
43+
* Operating system certificate store is used for TLS, in other words
44+
``certifi`` is not used as the certificate source
45+
* Proxy use can be configured with ``https_proxy`` and other similar
46+
environment variables
47+
48+
All of the HTTP decisions can be changed with ``fetcher`` argument:
49+
Custom ``FetcherInterface`` implementations are possible. The alternative
50+
``RequestsFetcher`` implementation is also provided (although deprecated).
3851
"""
3952

4053
from __future__ import annotations

0 commit comments

Comments
 (0)