python-tuf/tuf/ngclient
Teodora Sechkova e54ed249f5 Add docstrings in Updater
Add some missing docstrings in updater.py

Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
2021-05-21 13:07:27 +03:00
..
_internal ngclient: Fix logging to remove pylint disable 2021-05-21 11:28:46 +03:00
__init__.py Expose client public classes from __init__.py 2021-05-21 10:00:00 +03:00
fetcher.py Rename client_rework to ngclient 2021-05-21 10:00:00 +03:00
README.md ngclient: Update README 2021-05-21 11:54:56 +03:00
updater.py Add docstrings in Updater 2021-05-21 13:07:27 +03:00

Next-gen TUF client for Python

This package provides modules for TUF client implementers.

tuf.ngclient.Updater is a class that implements the client workflow described in the TUF specification (see https://theupdateframework.github.io/specification/latest/#detailed-client-workflow)

tuf.ngclient.FetcherInterface is an abstract class that client implementers can optionally use to integrate with their own network/download infrastructure -- a Requests-based implementation is used by default.

This package:

  • Aims to be a clean, easy-to-validate reference client implementation written in modern Python
  • At the same time aims to be the library choice for anyone implementing a TUF client in Python: light-weight, easy to integrate and with minimal required dependencies
  • Is still under development but planned to become the default client in this code base (as in the older tuf.client will be deprecated in the future)