Update finding and installing plugin docs #541

melissawm · 2024-12-17T20:19:12Z

References and relevant issues

Closes #122
Closes #354
Closes #532
Closes #508

Description

Update screenshots and text to reflect current state of napari plugin manager (also adds links to their docs)
Update instructions on deploying your plugin to conda-forge

melissawm · 2024-12-19T16:49:30Z

@TimMonko would you mind reviewing these changes? I'd be more than happy to address any suggestion you may have for improvements. Cheers!

TimMonko

Thanks for pinging me to leave a review. This is the first time I've reviewed a PR, so it took me a bit to figure everything out. Let me know if there is some review-specific etiquette or something that I've missed

TimMonko · 2024-12-19T17:39:49Z

docs/plugins/start_using_plugins/finding_and_installing_plugins.md

-  metadata, to produce a more user friendly way to find napari plugins.
+- **conda-forge:** You can search for napari plugins from
+  the conda-forge [package search page](https://conda-forge.org/packages/).
+- **napari hub:** The [napari hub](https://napari-hub.org) uses this data, together with additional


'This data' is ambiguous. I'm not sure how necessary it is. Maybe just something like' The napari-hub uses plugin-provided metadata to produce a more user-friendly way to find napari plugins.

TimMonko · 2024-12-19T17:40:52Z

docs/plugins/start_using_plugins/finding_and_installing_plugins.md


 Similarly, the napari application lists plugins, annotated on PyPI with `Framework :: napari`,
 in the `Plugins > Install/Uninstall Plugins` menu.

 ## Installing plugins with napari

 All PyPI packages annotated with the `Framework :: napari` tag can be installed
-directly from within napari:
-Firstly, from the “Plugins” menu, select “Install/Uninstall Plugins...”.
+directly from within napari, using the [napari plugin manager](https://napari.org/napari-plugin-manager/).


Perhaps it should be stated that npm is only installed with pip install napari[all], conda install napari, and the bundled app?

Oh this is a good point! The plugin manager has been devolved, so it's not in napari/napari anymore.

TimMonko · 2024-12-19T17:52:00Z

docs/plugins/start_using_plugins/finding_and_installing_plugins.md

-    the “Install” button next to the input bar. This method allows for more flexibility
-    in the plugins you can install, but it is also a bit more advanced.
+2. Install plugins via manual input: at the bottom of the napari plugin manager window, there is a text box that will
+   say either "install with 'pip' by name/url, or drop file...", or "install with 'pip' by name/url, or drop file..."


I assume this is meant to say 'conda' or something for one of them? Right now both say 'pip'. (my npm is currently not connecting in any install, no idea why, so I can't check)

oops yes, wrong copy/paste!

TimMonko · 2024-12-19T17:58:52Z

docs/plugins/start_using_plugins/finding_and_installing_plugins.md

+   If you want to install `napari-svg` from a specific release, enter `napari-svg==0.1.0` in the text field.
+   ```
+
+3. Advanced installation: after you have searched for the plugin you with to install, clicking on "Installation Info"


Suggested change

3. Advanced installation: after you have searched for the plugin you with to install, clicking on "Installation Info"

3. Advanced installation: after you have searched for the plugin you wish to install, clicking on "Installation Info"

TimMonko · 2024-12-19T18:08:04Z

docs/plugins/start_using_plugins/finding_and_installing_plugins.md

 Similarly, the napari application lists plugins, annotated on PyPI with `Framework :: napari`,
 in the `Plugins > Install/Uninstall Plugins` menu.


Suggested change

Similarly, the napari application lists plugins, annotated on PyPI with `Framework :: napari`,

in the `Plugins > Install/Uninstall Plugins` menu.

Redundant with below section, but especially with testing_and_publish/deploy.md

TimMonko · 2024-12-19T18:12:34Z

docs/plugins/virtual_environment_docs/2-deploying-your-plugin.md

-(deploying-to-anaconda)=
-## Deploying to Anaconda
+(deploying-to-conda-forge)=
+## Deploying to conda-forge
 This is only a brief guide to deploying to `conda-forge`. More information can be found in the [conda-forge docs](https://conda-forge.org/docs/maintainer/adding_pkgs.html).



Suggested change

Note that in order to deploy to `conda-forge` *all* build and run requirements (i.e. dependencies) *must* be available on `conda-forge`.

TimMonko · 2024-12-19T18:19:29Z

docs/plugins/virtual_environment_docs/2-deploying-your-plugin.md

@@ -102,7 +93,7 @@ This is only a brief guide to deploying to `conda-forge`. More information can b
 4. Update the **meta.yaml** file to include your package's build and run requirements
 5. Commit and open a PR to https://github.com/conda-forge/staged-recipes

-Once your recipe is approved and merged, the rest happens *automagically*, and your package will appear on the anaconda cloud.
+Once your recipe is approved and merged, the rest happens *automagically*, and your package will appear on the [conda-forge package list](https://conda-forge.org/packages/).

 This is **far** easier if you already have an `sdist` published to PyPI.


Suggested change

This is **far** easier if you already have an `sdist` published to PyPI.

This is **far** easier if you already have an `sdist` published to PyPI.

Updating your package on conda-forge: By default, when a new release is detected on PyPI, conda-forge bots will automatically make a pull requests to your `conda-forge/package-name-feedstock` and you must address any changes and approve the pull request.

Style this better than I have, but I think this is really important to add

TimMonko · 2024-12-19T18:24:52Z

docs/plugins/start_using_plugins/finding_and_installing_plugins.md

This is great. What comes to mind as missing is mention of how to upgrade plugins. I think, by default, a user working through npm has to uninstall and then reinstall the version they want. Is that correct? Is this the recommended way for most users?

the new plugin manager should update plugins too.

Automagically? I remember there used to be an 'upgrade' button or something, but on main that doesn't seems to be the case -- just uninstall is available (the plugin here has v0.9.7 available through npm, I intentionally used npm to download v0.9.5):

napari: 0.5.6.dev10+g224f8e9c Platform: Windows-11-10.0.22631-SP0 Python: 3.12.8 | packaged by conda-forge | (main, Dec 5 2024, 14:06:27) [MSC v.1942 64 bit (AMD64)] Qt: 5.15.2 PyQt5: 5.15.11 NumPy: 1.26.4 SciPy: 1.14.1 Dask: 2024.12.1 VisPy: 0.14.3 magicgui: 0.10.0 superqt: 0.7.0 in-n-out: 0.2.1 app-model: 0.3.1 psygnal: 0.11.1 npe2: 0.7.7 pydantic: 2.10.4 OpenGL: - GL version: 4.6.0 NVIDIA 551.78 - MAX_TEXTURE_SIZE: 32768 - GL_MAX_3D_TEXTURE_SIZE: 16384 Screens: - screen 1: resolution 1920x1080, scale 2.0 - screen 2: resolution 1440x2560, scale 1.0 Optional: - numba: 0.60.0 - triangle: 20230923 - napari-plugin-manager: 0.1.3 Settings path: - C:\Users\timmo\AppData\Local\napari\napari-testing_e9e6cb9e948feb28aa4661b58255680aebaae620\settings.yaml

Um it should work?
https://napari.org/napari-plugin-manager/index.html#updating-a-plugin
Maybe there's been a regression somewhere or it's another conda vs pip difference?

TimMonko · 2024-12-20T01:15:14Z

Another thing that I've just come across is this little bugger that could go into the documentation (or get a PR to change the behavior):

Right now, when you install a plugin through npm, the little loading animation will keep going and going AND if you've clicked off napari, then you won't know that isn't what the issue is. Instead its... the little npe2 restart popup causing npm to hang as if it was still installing

Once this little popup is closed, the loading animation stops and everything looks normal. Even to me as a user with experience, I often forget that it is actually done installing the plugin when I'm helping users work through npm (because the animation continues)

psobolewskiPhD · 2024-12-21T04:21:35Z

@TimMonko that sounds like a bug -- can you open an issue here https://github.com/napari/napari-plugin-manager

Update finding and installing plugin docs

5f07599

github-actions bot assigned melissawm Dec 17, 2024

github-actions bot added the documentation Improvements or additions to documentation label Dec 17, 2024

melissawm added 3 commits December 17, 2024 17:27

Add pip install example

70520ee

Merge branch 'main' into plugin-docs

f2e4f4d

Add more info about plugin manager installation workflow

3ccb513

melissawm mentioned this pull request Dec 19, 2024

Update the Finding and Installing a Plugin docs #122

Open

Run pngquant on new screenshot

df79cef

melissawm marked this pull request as ready for review December 19, 2024 16:43

Add note about deploying plugins to conda-forge

b4cf0d6

Mention deploying your plugin to conda-forge

c15da4f

TimMonko suggested changes Dec 19, 2024

View reviewed changes

TimMonko mentioned this pull request Dec 30, 2024

[Bug] Installation of a plugin appears to hang due to informational popup napari/napari-plugin-manager#123

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update finding and installing plugin docs #541

Update finding and installing plugin docs #541

melissawm commented Dec 17, 2024 •

edited

Loading

melissawm commented Dec 19, 2024

TimMonko left a comment •

edited

Loading

TimMonko Dec 19, 2024

TimMonko Dec 19, 2024

psobolewskiPhD Dec 20, 2024

TimMonko Dec 19, 2024

melissawm Dec 19, 2024

TimMonko Dec 19, 2024

TimMonko Dec 19, 2024

TimMonko Dec 19, 2024

TimMonko Dec 19, 2024

TimMonko Dec 19, 2024

TimMonko Dec 19, 2024

TimMonko Dec 19, 2024 •

edited

Loading

psobolewskiPhD Dec 20, 2024

TimMonko Dec 20, 2024

psobolewskiPhD Dec 21, 2024

TimMonko commented Dec 20, 2024

psobolewskiPhD commented Dec 21, 2024

	3. Advanced installation: after you have searched for the plugin you with to install, clicking on "Installation Info"
	3. Advanced installation: after you have searched for the plugin you wish to install, clicking on "Installation Info"

		Similarly, the napari application lists plugins, annotated on PyPI with `Framework :: napari`,
		in the `Plugins > Install/Uninstall Plugins` menu.



	Note that in order to deploy to `conda-forge` all build and run requirements (i.e. dependencies) must be available on `conda-forge`.

Update finding and installing plugin docs #541

Are you sure you want to change the base?

Update finding and installing plugin docs #541

Conversation

melissawm commented Dec 17, 2024 • edited Loading

References and relevant issues

Description

melissawm commented Dec 19, 2024

TimMonko left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TimMonko Dec 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TimMonko commented Dec 20, 2024

psobolewskiPhD commented Dec 21, 2024

melissawm commented Dec 17, 2024 •

edited

Loading

TimMonko left a comment •

edited

Loading

TimMonko Dec 19, 2024 •

edited

Loading