search

maurosilber / SMO

Robust and unbiased estimation of the background distribution for fluorescence microscopy.
MIT License
12 stars 4 forks source link

Add napari to requirements #2

Closed DragaDoncila closed 2 years ago

DragaDoncila commented 2 years ago

Hi team,

My name is Draga and I am a CZI contractor working on napari.

As part of our work on the new napari plugin engine, we’ve been running some automated tests to see whether plugins will be easily converted to the new plugin engine. While running these tests, we noticed that your plugin fails to be imported after installation in a fresh environment due to a missing requirement. You can see details in this github action run.

This PR therefore adds napari to your install requirements so that users can install your plugin more confidently.

Note that this may not be a complete list - to check whether your plugin can be easily installed on other machines, we recommend using GitHub workflows to test your plugin in a fresh environment - the napari plugin cookiecutter provides an example of such a workflow.

If you believe this PR has been opened in error, please feel free to close it and let us know where we went wrong!

maurosilber commented 2 years ago

Hi, Draga

While we do provide a napari plugin, this package is also usable independently from napari. So I'd prefer not to list napari as a dependency. I expect that non-tech-savvy users will install the plugin from the napari GUI, and hence already have an existent napari installation.

Is it necessary for the new napari engine?

DragaDoncila commented 2 years ago

While we do provide a napari plugin, this package is also usable independently from napari. So I'd prefer not to list napari as a dependency.

Ah ok, I understand. I noticed you were importing directly from napari in your plugin and that was the reason I added the requirement. However, if you're confident your users will always have napari in their environment before installing the plugin, then perhaps this dependency is not required - feel free to close this PR if that is the case!

Having seen many plugins importing from napari's layer models and typing modules, I'm thinking it may be worth releasing a "napari-lite"-like package or extra that provides access to these commonly imported classes/objects without also adding the heavier dependencies like PyQt and vispy - is that something you think would be useful to you @maurosilber?

Is it necessary for the new napari engine?

It is not necessary for the new napari engine - it's merely something we noticed as part of testing conversion to the new engine.

maurosilber commented 2 years ago

Indeed, a napari-lite, providing types and interfaces, might be useful. I thought that was the job of the napari_plugin_engine package, but I ended up needing to import from napari to let magic_gui build the plugin GUI from type annotations: https://github.com/maurosilber/SMO/blob/b9abc445d186a03fbe15c916d5e70bd2ae048ce4/smo/plugins/napari.py#L9

I will close this PR then.