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 napari plugin template, 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 best metadata and description for your plugin, see our comprehensive guide: Customizing your plugin’s listing on napari hub. This guide covers:

  • Setting package metadata in pyproject.toml

  • Using npe2 manifest metadata for hub display

  • Controlling plugin visibility

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 Get going quickly with the napari plugin template, you can also setup automated deployments on GitHub for every tagged commit.

conda-forge

You can also deploy your plugin to conda-forge. Check out deploying to conda-forge for more details on how to do that.

The napari-plugin-manager can be used to install plugins deployed to both PyPI and conda-forge.

When you are ready for users, announce your plugin on the Image.sc forum.