python-tuf/examples/client_example/README.md
Kairo de Araujo 183223e59c Simplify README, fix some flows and output
- Simplify README and better keywords
- Fix the verbosity
- Better docstrings
- Client flow for init and main are clear

Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>
2021-12-03 19:59:01 +01:00

26 lines
726 B
Markdown

# TUF Client Example
TUF Client Example, using ``python-tuf``.
This TUF Client Example implements the following actions:
- Client Infrastructure Initialization
- Download target files from TUF Repository
The example client expects to find a TUF repository running on localhost. We
can use the static metadata files in ``tests/repository_data/repository``
to set one up.
Run the repository using the Python3 built-in HTTP module, and keep this
session running.
```console
$ python3 -m http.server -d tests/repository_data/repository
Serving HTTP on :: port 8000 (http://[::]:8000/) ...
```
How to use the TUF Client Example to download a target file.
```console
$ ./client_example.py download file1.txt
```