Publish your plugin#
Preparing for release#
To help users find your plugin, make sure to use the Framework :: napari
classifier in your package’s core metadata. (If you used the cookiecutter,
this has already been done for you.)
Once your package is listed on PyPI (and includes the Framework :: napari
classifier), it will also be visible on the napari
hub. To ensure you are providing the relevant metadata and
description for your plugin, see the following documentation in the napari hub
GitHub’s docs
folder:
The hub
For more about the napari hub, see the napari hub About page. To learn more about the hub’s development process, see the napari hub GitHub’s Wiki.
If you want your plugin to be available on PyPI, but not visible on the napari
hub, you can add a .napari/config.yml file to the root of your repository with
a visibility key. For details, see the customization
guide.
Finally, once you have curated your package metadata and description, you can preview your metadata, and check any missing fields using the napari hub preview page service. Check out this guide for instructions on how to set it up.
Deployment#
When you are ready to share your plugin, upload the Python package to
PyPI after which it will be installable using python -m pip install <yourpackage>, or (assuming you added the Framework :: napari classifier)
in the builtin plugin installer dialog.
If you used the Cookiecutter template, you can also setup automated deployments on github for every tagged commit.
What about conda?
While you are free to distribute your plugin on anaconda cloud in addition to or instead of PyPI, the built-in napari plugin installer doesn’t currently install from conda. In this case, you may guide your users to install your package on the command line using conda in your readme or documentation.
A future version of napari and the napari stand-alone application may support directly installing from conda. As such, publishing to conda-forge can be a good idea. Checkout deploying to anaconda for more details.
When you are ready for users, announce your plugin on the Image.sc forum.