Skip to content

napari/napari-plugin-engine

Repository files navigation

napari plugin engine

License Build Status Docs Status codecov Python Version PyPI

napari-plugin-engine is the first generation napari plugin engine. We recommend new plugins should use the second generation npe2.

napari-plugin-engine is a fork of pluggy, modified by the napari team.

There are some API and feature changes, including:

  • discovery via naming convention as well as entry_points
  • support for reordering of hook calls after registration.
  • enhanced API for retrieving plugin package metadata.
  • modified plugin call and registration exception handling
  • modified HookResult object and hook call loop, with ability to retrieve the HookImplementation responsible for the result.
  • lazy plugin discovery
  • some changes to variable and attribute naming
  • removed all deprecated code
  • type annotations on everything
  • pytest fixtures for testing
  • a couple napari-specific convenience imports

For usage overview and a reference for the napari-plugin-engine API, see our Documentation

(see also: the pluggy documentation)

install

pip install napari-plugin-engine

Usage

see documentation