mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
4f71f98008
This allows using existing documentation in the published documentation without * moving the existing docs (which would break external links) * tricks like symlinks that create issues with relative links Put the api reference files into a subdirectory to avoid polluting the main docs/ directory. Include "Installation" and "Instructions for Contributors" in the published documentation. Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
33 lines
No EOL
1.2 KiB
ReStructuredText
33 lines
No EOL
1.2 KiB
ReStructuredText
API Reference
|
|
=====================
|
|
|
|
|
|
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
|
|
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
|
|
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.
|
|
|
|
.. note:: Major API changes are unlikely but these APIs are not yet
|
|
considered stable, and a higher-level repository operations API is not yet
|
|
included.
|
|
|
|
There is a legacy implementation in the source code (not covered by this
|
|
documentation): it is in maintenance mode and receives no feature work.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
tuf.api
|
|
tuf.ngclient |