GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — python-tuf/docs/api/api-reference.rst at develop · theupdateframework/python-tuf

Expand file tree

/

api-reference.rst

Copy path
More file actions
More file actions

Latest commit

 

History

History
History
34 lines (24 loc) · 1.28 KB
/

api-reference.rst

Copy path

File metadata and controls

34 lines (24 loc) · 1.28 KB
Raw
Copy raw file
Download raw file
Edit and raw actions

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'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 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.

Code examples are available for client implementation using ngclient and a basic repository using Metadata API.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   tuf.api
   tuf.ngclient

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.