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

Provide optional dependencies for qt instead of napari #84

Merged
merged 2 commits into from
Jun 24, 2024

Conversation

niksirbi
Copy link
Member

@niksirbi niksirbi commented Jun 13, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

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:

  • The code has been tested locally
  • Tests have been added to cover all new functionality (unit & integration)
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

Copy link

codecov bot commented Jun 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #84   +/-   ##
=======================================
  Coverage   91.59%   91.59%           
=======================================
  Files          35       35           
  Lines        1607     1607           
=======================================
  Hits         1472     1472           
  Misses        135      135           
Flag Coverage Δ
numba 91.53% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Member

@IgorTatarnikov IgorTatarnikov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good!

@IgorTatarnikov IgorTatarnikov merged commit 9f87ec1 into main Jun 24, 2024
14 checks passed
@adamltyson adamltyson mentioned this pull request Jul 29, 2024
4 tasks
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.

2 participants