brainglobe / brainglobe-utils

Shared general purpose tools for the BrainGlobe project
MIT License
11 stars 1 forks source link

Provide optional dependencies for qt instead of napari #84

Closed niksirbi closed 2 months ago

niksirbi commented 3 months ago

Description

What is this PR

Why is this PR needed? We were providing optional dependencies via brainglobe-utils[napari]. These included qtpy, superqt, and napari itself. I realised that the actual code for the collapsible widgets (located in the qtpy folder), doesn't actually make use of napari, so that dependency was unnecessary.

What does this PR do? We instead provide brainglobe-utils[qt], which include qtpy, superqt as before, but NOT napari. This should also simplify dependency management in packages that rely on the collapsible widgets.

References

I realised this while working on a napari widget for movement

How has this PR been tested?

Existing tests still pass (because napari was actually never even installed in the dev environment).

Is this a breaking change?

In a way, packages that depended on collapsible widgets (brainglobe-stitch and brainglobe-registration?) need to update their dependencies to brainglobe-utils[qt], and make sure to have a separate napari dependency. That's why I'm tagging @IgorTatarnikov as reviewer.

Does this PR require an update to the documentation?

The README has been updated accordingly.

Checklist:

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.59%. Comparing base (a64cd9a) to head (52a8fdc).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #84 +/- ## ======================================= Coverage 91.59% 91.59% ======================================= Files 35 35 Lines 1607 1607 ======================================= Hits 1472 1472 Misses 135 135 ``` | [Flag](https://app.codecov.io/gh/brainglobe/brainglobe-utils/pull/84/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brainglobe) | Coverage Δ | | |---|---|---| | [numba](https://app.codecov.io/gh/brainglobe/brainglobe-utils/pull/84/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brainglobe) | `91.53% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brainglobe#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.