Poc gui #739

ebba-eliasson · 2025-03-20T09:12:53Z

Read this before submitting the PR

Always create a Draft PR first
Go through sections 1-5 below, fill them in and check all the boxes
Make sure that the branch is updated; if there's an "Update branch" button at the bottom of the PR, rebase or update branch.
When all boxes are checked, information is filled in, and the branch is updated: mark as Ready For Review and tag reviewers (top right)
Once there is a submitted review, implement the suggestions (if reasonable, otherwise discuss) and request an new review.

If there is a field which you are unsure about, enter the edit mode of this description or go to the PR template; There are invisible comments providing descriptions which may be of help.

1. Description / Summary

Add a summary here: What does this PR add/change and why?

POC fot the DDS CLI new GUI/TUI

2. Jira task / GitHub issue

Is this a GitHub issue? --> Add the link to the github issue

Is this from a Jira task? --> If your branch does not contain info regarding the Jira task ID, put it here.

HMS-2332

3. Type of change - Add label

What type of change(s) does the PR contain? For an explanation of the different options below, enter edit mode of this PR description template.

If you do not want this change to be included in release notes, add the label skip-changelog.

New feature
- Breaking --> label: breaking
- Non-breaking --> label: feature
Database change --> label: feature or none at all.
Remember the to include a new migration version, or explain here why it's not needed.
Bug fix --> label: bug
Security Alert fix
- Package update --> label: dependency
  - Major version update
Documentation --> label can be skipped, will be included in "other changes"
Workflow --> label: skip-changelog
Tests only --> label: skip-changelog

4. Additional information

I have added an entry to the Sprintlog
This is a PR to the master branch: If checked, read the release instructions
- I have followed steps 1-8.

5. Actions / Scans

Make sure that the following checks/actions have passed.

Black

Prettier

Pylint

Yamllint

Tests

CodeQL

Trivy

Snyk

TestPyPI

If an action does not pass and you need help with how to solve it, enter edit mode of this PR template or go to the PR template.

codecov · 2025-03-20T09:14:00Z

Codecov Report

Attention: Patch coverage is 50.44643% with 222 lines in your changes missing coverage. Please review.

Project coverage is 48.74%. Comparing base (b2a295c) to head (6378544).
Report is 41 commits behind head on dev.

Files with missing lines	Patch %	Lines
dds_cli/gui_poc/pages/dds_auth.py	40.96%	49 Missing ⚠️
dds_cli/gui_poc/pages/dds_base_page.py	44.11%	38 Missing ⚠️
dds_cli/user.py	14.28%	36 Missing ⚠️
dds_cli/gui_poc/utils.py	51.72%	28 Missing ⚠️
dds_cli/gui_poc/components/dds_modal.py	42.50%	23 Missing ⚠️
dds_cli/gui_poc/pages/dds_home.py	61.11%	14 Missing ⚠️
dds_cli/gui_poc/app.py	72.00%	7 Missing ⚠️
dds_cli/gui_poc/components/dds_text_item.py	73.68%	5 Missing ⚠️
dds_cli/__main__.py	50.00%	4 Missing ⚠️
dds_cli/base.py	63.63%	4 Missing ⚠️
... and 8 more

Additional details and impacted files

@@            Coverage Diff             @@
##              dev     #739      +/-   ##
==========================================
+ Coverage   47.78%   48.74%   +0.96%     
==========================================
  Files          31       44      +13     
  Lines        2890     3315     +425     
==========================================
+ Hits         1381     1616     +235     
- Misses       1509     1699     +190

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

valyo · 2025-03-21T13:11:52Z

I give it a try and this time I got blanc terminal when I ran "dds gui". No error in the container log.
When I switched to the commit I previously tested

commit aaf063c8e14f2fde2cd7904eba67e5a19690727b (HEAD)                                                                                                                                                                               [0/858]
Author: ebba-eliasson <ebba.eliasson@scilifelab.se>
Date:   Wed Mar 19 09:24:37 2025 +0100

    Auth commands done

it worked again (without the user functionality obviously). So it must be something in the last two commits.
@ebba-eliasson does it work for you in the docker environment?

i-oden · 2025-03-24T10:21:25Z

@ebba-eliasson I'm also getting an empty terminal atm

valyo · 2025-03-24T10:29:21Z

@ebba-eliasson I'm also getting an empty terminal atm

I had an empty terminal and what, I suspect, helped was to first run the dds command normally without the gui
Question remains, why it behaves so, but hopefully this can help you, @i-oden, to test it

ebba-eliasson · 2025-03-24T10:39:53Z

@i-oden @valyo I have located the issue, seems to be that components are loaded before I though they loaded (introduced thought the user info page). A solution until I fix it is to authenticate yourself using the "dds auth login" command and then run dds gui to look at it.

i-oden

This looks great, you've done an awesome job! 🎉

I've added a bunch of comments and sometimes they may be in the wrong place so sorry about that, but I think it's fairly understandable what I mean. If not, just ask!

Also, I didn't dive in to all the code details atm, I mainly went on functionality now, so I'll do another review, but this review is already quite wordy so I think lets start there. I have focused on details though. I think before we continue with any more of the functionality (e.g. projects etc) we should decide on what we have atm.

dds_cli/account_manager.py

i-oden · 2025-03-24T09:47:44Z

dds_cli/__main__.py

@@ -168,6 +171,16 @@ def dds_main(click_ctx, verbose, log_file, no_prompt, token_path):
        # Create context object
        click_ctx.obj = {"NO_PROMPT": no_prompt, "TOKEN_PATH": token_path}

+### GUI COMMAND ###
+
+@dds_main.command(name="gui")


Should be able to make an "executable" for only GUI right? Which in this case would start the GUI command after clicking the file?

I just want to make sure that the GUI actually avoids commands all together

Should be the case, will look into that though. Right now it uses the click context for getting the token path, so we would just need some util for getting that.

@i-oden from the textual documentation it is suggested to use https://textual.textualize.io/how-to/package-with-hatch/#installing-the-calculator, but other options seems to work as well Textualize/textual#4512

i-oden · 2025-03-24T10:02:22Z

dds_cli/gui_poc/docs/poc_dds_auth.md

+
+### Issues with the PyQt implementation 
+
+The idea was to use PyQt6 as a framework for building the GUI for the DDS but Pyqt dont work on alpine and hence would not install in the container enviroment. In addition to this, there is benfifits using a TUI (Terminal UI) as some users are **only** able to run dds in the terminal. There is no loss in functionallity switching from pyqt to textualize. Textualize is confirmed to work with the current docker setup. 


We have been discussing switching from Alpine -- if we think that PyQT is better than we should switch.
Re: some users only being able to run the dds in the terminal -- as long as the users don't have to run any commands to start the GUI (as in they can, but they don't have to), then I'm ok with Textualize.

After working with both frameworks I would not say that pyqt is better than textualize or vice versa, they are good at different things and functionality wise both would work fine.

It generally seems to be some issues sometimes with the pyqt build.

As per previous discussion, will look at stating textualize without terminal.

Update on the pyqt build: There is additional problems, with builds timing out running the instalment of pyqt on say python:3.12 image.

FROM python:3.12 RUN apt-get update && apt-get install -y \ g++ \ gcc \ make \ cmake \ musl-dev \ libffi-dev \ qt6-base-dev \ qt6-base-private-dev ENV PATH="/usr/lib/qt6/bin:${PATH}" RUN pip install PyQt6

dds_cli/gui_poc/docs/poc_ux_ui.md

i-oden · 2025-03-24T12:19:42Z

dds_cli/gui_poc/user.py

+            self.user_info = {"Not authenticated": "Please login to DDS."}
+
+        if self.user_info:
+            self.add_column("Key")


We need to think of either another display or changing to something else than "Key" and "Value"

Should be possible to have a table display without a header

Or use a list view or something.

i-oden · 2025-03-24T12:22:04Z

dds_cli/gui_poc/user.py

+        if self.user_info:
+            self.add_column("Key")
+            self.add_column("Value")
+            for key, value in self.user_info.items():


I'd also like us to rearrage the order of these at some point so that they are displayed in the following order:

username

role

name

primary email

all emails

Will leave right now until we decide on how to display.

i-oden · 2025-03-24T12:27:20Z

dds_cli/gui_poc/docs/poc_dds_auth.md

+### Comments 
+
+- For some cli functions it's enough to just add a return statement in the method
+- The authentication would need to be either reformated or adding a parallel authentication for the gui --> could be a better solution to rewrite the authenticatin flow all together 


Yes we don't want the parallel authentication, we want to reduce the amount of duplicate code as much as possible, so I agree that the better solution is to refactor the authentication flow

We would need to have a discussion about the whole auth flow of the application

i-oden · 2025-03-24T12:32:43Z

dds_cli/gui_poc/docs/poc_ux_ui.md

+
+### Text
+
+There is no support for different fontsizes in textual. 


This ties into one of my other comments -- the bar at the bottom. The size itself isn't a huge problem, but we definitely need to make those buttons clearer by moving them somewhere else and also possibly changing some other layout if not hte font size

We could probably make a sidebar, but generally textualize is much more limited when it comes to customisation, compared to what we might be used with from web development. I don't think the bar itself is a problem, you get used to it quite fast, but I agree that it can be complicated when first using, or if you are not experienced with the system.

i-oden · 2025-03-24T12:34:34Z

dds_cli/gui_poc/docs/poc_ux_ui.md

+Group commands (in this case user) is availible through the footer bindings and have a layout using a sidebar corresponding to commands. The sidebar can have a title (now "DDS Sidebar") and a help button displaying a modal with markdown. This type of layput could be applied to all command groups. 
+
+![image](group_page.jpeg)
+![iamge](help.jpeg)


I don't really understand what this image shows

Which part? The help or "group page"?

The help I think

It shows the help pop up and an example of how markdown looks in textualize

Co-authored-by: Ina Odén Österbo <35953392+i-oden@users.noreply.github.com>

…o poc-gui

ebba-eliasson added 13 commits March 10, 2025 15:40

Add GUI click command + implement some account commands

36ea537

Start implementing auth commands

2daf881

Continue working on auth, issues with token dates

4854731

Auth working with gui

a2acb58

Cleanup code

8395009

Add doc to GUI POC

c4bffb8

Add PyQt to requirements

93d4f9c

Remove unused class

cf928f5

Change readme after decicion to kill pyqt

0a355d7

Start working on textual tui

824534a

Contiune working on auth

de02d5e

Auth commands done

aaf063c

Add user info page

804f842

Add file select util

513f7e0

ebba-eliasson force-pushed the poc-gui branch from 29b8597 to 513f7e0 Compare March 21, 2025 10:51

Add support for non auth usage on user page

0bfed35

Add data and project view

4f52203

Disable project page

64c31d6

i-oden requested changes Mar 24, 2025

View reviewed changes

ebba-eliasson and others added 6 commits March 25, 2025 08:53

Update dds_cli/account_manager.py

c982570

Co-authored-by: Ina Odén Österbo <35953392+i-oden@users.noreply.github.com>

Doc review comments

032ae3c

Some reformatting and added comments

04abf5c

Add executable script

9c8bcbc

Add req to exe build

e552fc0

Change Tcss file and add executable workflow

cd31803

ebba-eliasson and others added 30 commits March 27, 2025 10:14

Change workflow

443f83c

Change workflow

700df9a

Change workflow

6b3e756

Change workflow

4bb716a

Add testing to workflow

875d9ac

Update workflow testing

4e12464

Update workflow testing

6a527cb

Update workflow testing

5e380bb

Update workflow testing

584d5f5

Add ubuntu to workflow

7864a20

Add windows to workflow

bda22ab

Update workflow test windows

6bec98f

Update workflow test windows

3b12064

Update workflow test windows

3e8490e

Update workflow test windows

dd4005c

Update workflow exe windows

d4c1c57

Update workflow exe windows

bd88e7d

Update workflow exe windows

d72f45c

Disable windows workflow test

d2d05dc

Windows test

77c6bca

Windows test

bc991cc

Windows test

3c7a7d6

Start new layout

850a5a0

Progress on new poc

e909796

Start working on state managment

5737ea3

add executable uploading as artifacts

9213a54

upgrade artifact action version to v4

1a9169f

add executable for Suse linux (Dardel's distro)

6378544

Start implementing new layout

4d89d73

Merge branch 'poc-gui' of github.com:ScilifelabDataCentre/dds_cli int…

fb0cb32

…o poc-gui

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Poc gui #739

Poc gui #739

ebba-eliasson commented Mar 20, 2025

codecov bot commented Mar 20, 2025 •

edited

Loading

valyo commented Mar 21, 2025

i-oden commented Mar 24, 2025

valyo commented Mar 24, 2025

ebba-eliasson commented Mar 24, 2025

i-oden left a comment

i-oden Mar 24, 2025

i-oden Mar 24, 2025

ebba-eliasson Mar 25, 2025

ebba-eliasson Mar 25, 2025

i-oden Mar 24, 2025

ebba-eliasson Mar 25, 2025

ebba-eliasson Mar 25, 2025

i-oden Mar 24, 2025

ebba-eliasson Mar 25, 2025

ebba-eliasson Mar 25, 2025

i-oden Mar 24, 2025

ebba-eliasson Mar 25, 2025

i-oden Mar 24, 2025

ebba-eliasson Mar 25, 2025

i-oden Mar 24, 2025

ebba-eliasson Mar 25, 2025

i-oden Mar 24, 2025

ebba-eliasson Mar 25, 2025

i-oden Mar 26, 2025

ebba-eliasson Mar 26, 2025


		### Issues with the PyQt implementation

		The idea was to use PyQt6 as a framework for building the GUI for the DDS but Pyqt dont work on alpine and hence would not install in the container enviroment. In addition to this, there is benfifits using a TUI (Terminal UI) as some users are only able to run dds in the terminal. There is no loss in functionallity switching from pyqt to textualize. Textualize is confirmed to work with the current docker setup.


		### Text

		There is no support for different fontsizes in textual.

Poc gui #739

Are you sure you want to change the base?

Poc gui #739

Conversation

ebba-eliasson commented Mar 20, 2025

Read this before submitting the PR

1. Description / Summary

2. Jira task / GitHub issue

3. Type of change - Add label

4. Additional information

5. Actions / Scans

codecov bot commented Mar 20, 2025 • edited Loading

Codecov Report

valyo commented Mar 21, 2025

i-oden commented Mar 24, 2025

valyo commented Mar 24, 2025

ebba-eliasson commented Mar 24, 2025

i-oden left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Mar 20, 2025 •

edited

Loading