Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

TUF Python Client Example/Tutorial #1675

Merged
merged 8 commits into from
Dec 7, 2021
Merged

TUF Python Client Example/Tutorial #1675

merged 8 commits into from
Dec 7, 2021

Commits on Dec 3, 2021

  1. WIP: TUF Python Client Example/Tutorial 

    It is a simple example of TUF ngclient implementation.

This example contains a README.rst that is a tutorial/how-to-use
this simple client using static test data from TUF repository.

The code aims to be straightforward implementation, using basic
concepts from Python and Command Line Interface.

This is part of theupdateframework#1518

Signed-off-by: Kairo de Araujo <[email protected]>
    Kairo de Araujo committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    ffe2c11 View commit details
    Browse the repository at this point in the history

  2. Added lint, rst to md, output 

    - Added the lint to examples
- README format moved from Restructuredtext to Markdown
- Removed the [INFO] and [ERROR] from output, to avoid confundint with
  logging structure

Signed-off-by: Kairo de Araujo <[email protected]>
    Kairo de Araujo committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    9b4fcdb View commit details
    Browse the repository at this point in the history

  3. Implement a combination of print and logging 

    Using ``print`` for high-level client output
Option to see ``tuf.ngclient`` logging output

Update the README.

Signed-off-by: Kairo de Araujo <[email protected]>
    Kairo de Araujo committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    46629c4 View commit details
    Browse the repository at this point in the history

  4. Add a simple example handling TUF exceptions. 

    To highlight TUF ngclient exceptions.

Signed-off-by: Kairo de Araujo <[email protected]>
    Kairo de Araujo committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    4c5581a View commit details
    Browse the repository at this point in the history

  5. Removes the Python Client Example as WIP 

    This commit adds many comments from the WIP stage

Signed-off-by: Kairo de Araujo <[email protected]>
    Kairo de Araujo committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    4c37f1b View commit details
    Browse the repository at this point in the history

  6. Single error handling for updater 

    To simple exemplify, the updater calls are added to a single block
that handles the exceptions

Signed-off-by: Kairo de Araujo <[email protected]>
    Kairo de Araujo committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    ca13d05 View commit details
    Browse the repository at this point in the history

  7. 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 <[email protected]>
    Kairo de Araujo committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    183223e View commit details
    Browse the repository at this point in the history

  8. This commit fixes the verbosity (-v) levels. 

    without -v is ERROR logging, -v  WARNINGS logging, -vv INFO logging
and -vvv (+) DEBUG logging.

Signed-off-by: Kairo de Araujo <[email protected]>
    Kairo de Araujo committed Dec 3, 2021
    Configuration menu
    Copy the full SHA
    1344410 View commit details
    Browse the repository at this point in the history