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

Update UI to improve user experience #45

Merged
merged 17 commits into from
Apr 9, 2024
Merged

Update UI to improve user experience #45

merged 17 commits into from
Apr 9, 2024

Conversation

ebrocas
Copy link
Collaborator

@ebrocas ebrocas commented Dec 1, 2023

The goal of this PR is to propose some adjustments to improve user experience, especially new one who do not know about diffing details. As there is no Quick start on the documentation, I've tried to add as much as possible information in the usage.

This PR contains the following changes:

  • rewrite the usage of the CLI
  • uniformize options name of the CLI
  • add an option to have no output with the CLI expecpt erros
  • always save a result file
  • if no loader is provided, the CLI will determine the loader to use with the suffix of the files provided
  • add colored logs
  • progress bars has been moved from the internal API to the CLI. To avoid loading graphical stuff when you only want to manipulate the API
  • move bin/qbindiff to a __main__ and create an entry point

Added dependency:

  • rich-click

Removed dependency:

  • click
  • tqdm

usage :
image

final result:
image

@ebrocas ebrocas marked this pull request as ready for review December 1, 2023 16:27
@ebrocas ebrocas requested review from RobinDavid and patacca December 1, 2023 16:27
@patacca
Copy link
Collaborator

patacca commented Jan 30, 2024

I rebased it on main, reformat the code and changed a few details

@patacca
Copy link
Collaborator

patacca commented Feb 14, 2024

I rebased it on main, resolving few conflicts

@RobinDavid
Copy link
Collaborator

Good on my side. @patacca can you proof-test the latest changes before we merge ?

@patacca
Copy link
Collaborator

patacca commented Apr 8, 2024

I rebased it on the current main and added a few dirty hacks to avoid breaking the inheritance between the two classes QBinDiff and Differ.

I also took the chance to fix a few small things that went unnoticed.

This also comes with a change in the signature of the GenericPrePass and GenericPostPass callbacks, that now can optionally return an iterator (from 0 to 1000) that will be used for the progress bar.

The PR passes all the (very limited) tests and visually seems very nice 😉

@patacca patacca merged commit 51f4f39 into main Apr 9, 2024
@patacca patacca deleted the feat/cli-ui branch April 9, 2024 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants