Skip to content

Commit

Permalink
ngclient: Add docs on HTTP in general
Browse files Browse the repository at this point in the history
Signed-off-by: Jussi Kukkonen <[email protected]>
  • Loading branch information
jku committed Feb 14, 2025
1 parent f396735 commit 0490007
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions tuf/ngclient/updater.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,19 @@
A simple example of using the Updater to implement a Python TUF client that
downloads target files is available in `examples/client
<https://github.com/theupdateframework/python-tuf/tree/develop/examples/client>`_.
Notes on how Updater uses HTTP by default:
* urllib3 is the HTTP library
* Typically all requests are retried by urllib3 three times (in cases where
this seems useful)
* Operating system certificate store is used for TLS, in other words
``certifi`` is not used as the certificate source
* Proxy use can be configured with ``https_proxy`` and other similar
environment variables
All of the HTTP decisions can be changed with ``fetcher`` argument:
Custom ``FetcherInterface`` implementations are possible. The alternative
``RequestsFetcher`` implementation is also provided (although deprecated).
"""

from __future__ import annotations
Expand Down

0 comments on commit 0490007

Please sign in to comment.