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.

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

add progress display handler and api #1116

Merged
merged 2 commits into from
Oct 10, 2022
Merged

add progress display handler and api #1116

merged 2 commits into from
Oct 10, 2022

Conversation

ryanfkeepers
Copy link
Contributor

Description

Adds a new package- Observe- for owning user-
oriented displays like progress bars. This PR adds
an initial progress bar to onedrive backups as a
proof-of-concept. The API is more important than
the specific progress bar package at this time.
Future changes may opt for a different pkg.

Display format currently looks like:

59% [=============>           ] (6.9/12 kB, 14 MB/s)  |  Item_Name.txt

Known Issues:

  • the progressbar package does not support multiline output, and the author is not planning to add support. This causes concurrent items to overwrite each other. We will either need to fork the library, or change to a different one.

Type of change

  • 🌻 Feature

Issue(s)

Test Plan

  • 💪 Manual
  • ⚡ Unit test

Adds a new package- Observe- for owning user-
oriented displays like progress bars.  This PR adds
an initial progress bar to onedrive backups as a
proof-of-concept.  The API is more important than
the specific progress bar package at this time.
Future changes may opt for a different pkg.
@sonarcloud
Copy link

sonarcloud bot commented Oct 10, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@ryanfkeepers ryanfkeepers marked this pull request as ready for review October 10, 2022 22:08
@aviator-app
Copy link
Contributor

aviator-app bot commented Oct 10, 2022

Aviator status

Aviator will automatically update this comment as the status of the PR changes.

This PR was merged using Aviator.

@aviator-app aviator-app bot merged commit 2cc9b7b into main Oct 10, 2022
@aviator-app aviator-app bot deleted the issue-1112 branch October 10, 2022 22:53
@gmatev
Copy link
Contributor

gmatev commented Oct 11, 2022

Thanks @ryanfkeepers - This one looks promising for the multi-pb use case - https://github.com/vbauerster/mpb/

ryanfkeepers added a commit that referenced this pull request Oct 11, 2022
## Description

Adds a new package- Observe- for owning user-
oriented displays like progress bars.  This PR adds
an initial progress bar to onedrive backups as a
proof-of-concept.  The API is more important than
the specific progress bar package at this time.
Future changes may opt for a different pkg.

Display format currently looks like:
```
59% [=============>           ] (6.9/12 kB, 14 MB/s)  |  Item_Name.txt
```

Known Issues:
* the `progressbar` package does not support multiline output, and [the author is not planning to add support](schollz/progressbar#6).  This causes concurrent items to overwrite each other.  We will either need to fork the library, or change to a different one.  

## Type of change

- [x] 🌻 Feature

## Issue(s)

* #1112

## Test Plan

- [x] 💪 Manual
- [x] ⚡ Unit test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request mergequeue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants