feat: use embedded qt browser for jdaviz standalone

[maartenbreddels]

Description

This allows running jdaviz in its own browser (using qt) for the command line and the standalone version

Change log entry

• Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
  list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
  should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

• Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
• Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
• Do the proposed changes follow the STScI Style Guides?
• Are tests added/updated as required? If so, do they follow the STScI Style Guides?
• Are docs added/updated as required? If so, do they follow the STScI Style Guides?
• Did the CI pass? If not, are the failures related?
• Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
• After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

[pllim]

Nope... Error: Error: Timed out waiting for: tcp:8765 for Ubuntu

[camipacifici]

Starting server on http://localhost:60717
INFO: Started server process [19275]
INFO: Waiting for application startup.
INFO: Application startup complete.
INFO: Uvicorn running on http://localhost:60717 (Press CTRL+C to quit)
Traceback (most recent call last):
File "/Users/cpacifici/opt/miniconda3/envs/pr3188/bin/jdaviz", line 8, in
sys.exit(_main())
^^^^^^^
File "/Users/cpacifici/opt/miniconda3/envs/pr3188/lib/python3.11/site-packages/jdaviz/cli.py", line 149, in _main
main(filepaths=args.filepaths, layout=layout, instrument=args.instrument, browser=args.browser,
File "/Users/cpacifici/opt/miniconda3/envs/pr3188/lib/python3.11/site-packages/jdaviz/cli.py", line 78, in main
run_solara(host=host, port=port, theme=theme, browser=browser)
File "/Users/cpacifici/opt/miniconda3/envs/pr3188/lib/python3.11/site-packages/jdaviz/cli.py", line 93, in run_solara
from qtpy.QtWidgets import QApplication
File "/Users/cpacifici/opt/miniconda3/envs/pr3188/lib/python3.11/site-packages/qtpy/init.py", line 287, in
raise QtBindingsNotFoundError from None
qtpy.QtBindingsNotFoundError: No Qt bindings could be found

:(

[maartenbreddels]

Not sure what we should do here.

[maartenbreddels]

I included optional dependencies now @camipacifici , so running

$ pip install -e ".[qt]"

Should get you the correct dependencies.

[camipacifici]

Thank you! I had to install also PyQtWebEngine. After that, it launched!

[codecov]

Codecov Report

Attention: Patch coverage is 3.84615% with 25 lines in your changes missing coverage. Please review.

Project coverage is 88.36%. Comparing base (88ff8da) to head (9bf74d6).

Files with missing lines	Patch %	Lines
jdaviz/cli.py	3.84%	25 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3188      +/-   ##
==========================================
- Coverage   88.45%   88.36%   -0.10%     
==========================================
  Files         124      124              
  Lines       18389    18409      +20     
==========================================
+ Hits        16266    16267       +1     
- Misses       2123     2142      +19     

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

[maartenbreddels]

ValueError: Key backend: 'module://matplotlib_inline.backend_inline' is not a valid value for backend; supported values are ['gtk3agg', 'gtk3cairo', 'gtk4agg', 'gtk4cairo', 'macosx', 'nbagg', 'notebook', 'qtagg', 'qtcairo', 'qt5agg', 'qt5cairo', 'tkagg', 'tkcairo', 'webagg', 'wx', 'wxagg', 'wxcairo', 'agg', 'cairo', 'pdf', 'pgf', 'ps', 'svg', 'template']
[PYI-12940:ERROR] Failed to execute script 'jdaviz-cli-entrypoint' due to unhandled exception!

Strange to see this error come back from #2944

[kecnry]

since qt is an optional dependency (and we want to keep it that way), can this default to qt only if it is installed and otherwise use the system browser?

[maartenbreddels]

This is only for the standalone, which is built in CI with qt installed. Or do you mean if people build in locally?

[kecnry]

if anyone installs jdaviz (from pip for example) but not using the standalone installer, they still have access to the CLI, but may not have the qt optional dependencies.

[maartenbreddels]

But they would not use this file right, maybe you are confusing it with cli.py?

[kecnry]

if these fail to import, should we throw an error with instructions to install the optional dependencies?

[maartenbreddels]

Indeed, good idea.

[maartenbreddels]

I've put this in qt.py

[kecnry]

what do we need to do to get the tests passing, do we just make sure CI is installing qt or will it still fail on headless setups? It doesn't look like there are conflicts, but also might be worth rebasing since this sat for a while (sorry about that!)