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

Update the Finding and Installing a Plugin docs #122

Open
psobolewskiPhD opened this issue Mar 15, 2023 · 10 comments · May be fixed by #541
Open

Update the Finding and Installing a Plugin docs #122

psobolewskiPhD opened this issue Mar 15, 2023 · 10 comments · May be fixed by #541

Comments

@psobolewskiPhD
Copy link
Member

🧰 Task

napari PR napari/napari#5198 overhauled the plugin installation GUI, implementing a new Plugin Manager. As a result, the existing docs:
https://napari.org/stable/plugins/find_and_install_plugin.html#finding-and-installing-a-napari-plugin
need to be updated.
CC: @ppwadhwa @goanpeca

@melissawm
Copy link
Member

I believe this is completed, can you confirm @psobolewskiPhD ?

@melissawm melissawm moved this from Prioritized to outdated? in Documentation Working Group Oct 22, 2024
@psobolewskiPhD
Copy link
Member Author

psobolewskiPhD commented Oct 31, 2024

I don't think so https://napari.org/stable/plugins/start_using_plugins/finding_and_installing_plugins.html#find-and-install-plugins still doesn't reflect the current state of the plugin manager -- which is soon to change, in that the plugins will not be listed by default but require filtering (ala VS Code extensions).
Importantly, it doesn't mention the possibility of using conda vs pip.
We can wait to update once the plugin manager UI is settled?

Edit: actually, the plugin manager has nice docs now:
https://napari.org/napari-plugin-manager/

we could link to those?

@melissawm
Copy link
Member

Can you clarify - do you mean we can install a plugin from within the napari plugin manager using conda, or that you can use conda-forge to install a plugin?

@melissawm melissawm linked a pull request Dec 17, 2024 that will close this issue
@psobolewskiPhD
Copy link
Member Author

Both? 🤣

@melissawm
Copy link
Member

Sorry, I don't follow. If I type a name in the search bar, it's installed with pip, right? (even if I'm inside a conda env)

I guess my question is what information is missing from the guide (and my PR update?)

@psobolewskiPhD
Copy link
Member Author

psobolewskiPhD commented Dec 18, 2024

The big change:

  • Installation Info allows you to pick conda(forge) or pip, defaulting to how napari was installed. In the bundle, currently it's just conda, but with the next release will allow over-ridding to install from pip.
  • the bottom text entry bar also allows you to choose conda or pip. This bar is actually quite powerful: it can install arbitrary packages.

Merged, but not released:

  • UI/UX: you need to start typing to search -- there is no longer a pre-populated list.

The docs are hosted on napari.org maybe we can just integrate them?
https://napari.org/napari-plugin-manager/

@melissawm
Copy link
Member

Can you give me an example of how to choose conda with the bottom text entry?

@psobolewskiPhD
Copy link
Member Author

It's shown here:
https://napari.org/napari-plugin-manager/#installing-a-plugin-via-direct-entry
But there is a catch: apparently conda only shows if you installed napari from conda!
I was very confused because my dev env didn't show it (pip -e install) while my 0.5.5 env did (conda install).
I think the reason for this is that conda doesn't check site-packages so it will reinstall everything and good chance of breaking the env. Pip does check site-packages so it shouldn't reinstall much.
So those plugin manager docs should make that clearer.

@melissawm
Copy link
Member

Got it! Thanks - I'll try to word that correctly in our napari pages.

@melissawm
Copy link
Member

Wow that is powerful indeed - just added a commit to address it in #541 (comment)

@melissawm melissawm moved this from outdated? to In progress in Documentation Working Group Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In progress
Development

Successfully merging a pull request may close this issue.

3 participants