Elgato_dark/python-tuf
1
0
Fork 0
mirror of https://github.com/theupdateframework/python-tuf synced 2026-05-24 10:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Improve ngclient docs

Browse source 
Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
This commit is contained in:
Jussi Kukkonen 2021-08-23 10:46:25 +03:00 committed by Teodora Sechkova
parent 1a714f7dc8
commit 657aa3dfd5
No known key found for this signature in database
GPG key ID: 65F78F613EA1914E
2 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/api/tuf.ngclient.rst
View file

@ -1,8 +1,15 @@
ngclient
========
The ngclient module contains a complete TUF client library implementation.
* :doc:`tuf.ngclient.updater` implements the client update workflow
* :doc:`tuf.ngclient.config` provides optional configuration for the updater
* :doc:`tuf.ngclient.fetcher` can be used for optional low-level network I/O control
.. toctree::
:maxdepth: 4
:hidden:
tuf.ngclient.updater
tuf.ngclient.config

6
tuf/ngclient/updater.py
View file

@ -1,9 +1,9 @@
# Copyright 2020, New York University and the TUF contributors
# SPDX-License-Identifier: MIT OR Apache-2.0
"""TUF module that implements the client update workflow.
"""Client update workflow implementation
This module contains the Updater class that provides an implementation of the
The Updater class provides an implementation of the
`TUF client workflow
<https://theupdateframework.github.io/specification/latest/#detailed-client-workflow>`_.
Updater provides an API to query available targets and to download them in a
@ -37,7 +37,7 @@
metadata at "/tuf-repo/" and targets at "/targets/"
* Local metadata directory "~/tufclient/metadata/" is writable and contains
a root metadata version for the remote repository
* Download directory "~/target-downloads/" is writable
* Download directory "~/tufclient/downloads/" is writable
Example::