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
python-tuf/tuf/ngclient
History
Jussi Kukkonen 868afda420 docs: Change object attribute doc style 
Situation before
* constructor args are not documented
* object attributes are documented
* sphinx cannot show object attribute type annotations
* attribute docs take a lot of vertical space

Now:
* constructor args are documented
* sphinx can show annotated types of constructor args
* class docstring now explains the attributes are the same as
  constructor args (and attributes are not explicitly documented)

Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-09-23 17:51:46 +03:00
..
_internal Metadata API: change meta type in Timestamp 2021-09-20 14:09:38 +03:00
__init__.py Add client config module 2021-07-05 18:35:32 +03:00
config.py ngclient UpdaterConfig: Add docstring 2021-08-16 16:54:42 +03:00
fetcher.py Remove max_length parameter from fetch 2021-08-30 15:29:14 +03:00
README.md Improve README 2021-07-05 10:45:19 +03:00
updater.py docs: Change object attribute doc style 2021-09-23 17:51:46 +03:00

README.md

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 implement a concrete class of in order to reuse their own networking/download libraries -- 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 of choice for anyone implementing a TUF client in Python: light-weight, easy to integrate and with minimal required dependencies
  • Is still under development but is planned to become the default client in this implementation (i.e., the older tuf.client will be deprecated in the future)