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: Add links to the specification

Browse source 
Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
This commit is contained in:
Teodora Sechkova 2021-08-25 16:59:31 +03:00
parent 657aa3dfd5
commit e5de36f4e0
No known key found for this signature in database
GPG key ID: 65F78F613EA1914E
2 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/api/api-reference.rst
View file

@ -6,14 +6,14 @@ TUF provides multiple APIs:
* The low-level :doc:`tuf.api` provides access to a Metadata file abstraction
that closely follows the TUF specification and the file format: This API
handles de/serialization to and from files and makes it easier to access
that closely follows the TUF specification's `document formats`_.
This API handles de/serialization to and from files and makes it easier to access
and modify metadata content safely. It is purely focused on individual
pieces of Metadata and provides no concepts like "repository" or "update
workflow".
* The client update workflow is implemented in the :doc:`tuf.ngclient` module: It is
a higher-level API that provides ways to query and download target files
* The `client update workflow`_ is implemented in the :doc:`tuf.ngclient` module:
It is a higher-level API that provides ways to query and download target files
securely, while handling the TUF update workflow behind the scenes. ngclient
is implemented on top of the Metadata API and can be used to implement
various TUF clients with relatively little effort.
@ -30,4 +30,7 @@ TUF provides multiple APIs:
:caption: Contents:
tuf.api
tuf.ngclient
tuf.ngclient
.. _client update workflow: https://theupdateframework.github.io/specification/latest/#detailed-client-workflow
.. _document formats: https://theupdateframework.github.io/specification/latest/#document-formats

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

@ -3,7 +3,7 @@ ngclient
The ngclient module contains a complete TUF client library implementation.
* :doc:`tuf.ngclient.updater` implements the client update workflow
* :doc:`tuf.ngclient.updater` implements the `detailed client 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
@ -15,3 +15,5 @@ The ngclient module contains a complete TUF client library implementation.
tuf.ngclient.config
tuf.ngclient.fetcher
.. _detailed client workflow: https://theupdateframework.github.io/specification/latest/#detailed-client-workflow