1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
# napari plugin engine
[](https://github.com/napari/napari-plugin-engine/raw/master/LICENSE)
[](https://travis-ci.com/napari/napari-plugin-engine)
[](https://readthedocs.org/projects/napari_plugin_engine/)
[](https://codecov.io/gh/napari/napari)
[](https://python.org)
[](https://pypi.org/project/napari-plugin-engine)
`napari-plugin-engine` is a fork of [pluggy](https://github.com/pytest-dev/pluggy),
modified by the [napari](https://github.com/napari/napari) team.
There are some API and feature changes, including:
- discovery via [naming
convention](https://packaging.python.org/guides/creating-and-discovering-plugins/#using-naming-convention)
as well as
[entry_points](https://packaging.python.org/guides/creating-and-discovering-plugins/#using-package-metadata)
- 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](https://napari-plugin-engine.readthedocs.io/en/latest/)
(see also: the [pluggy documentation](https://pluggy.readthedocs.io/en/latest/))
## install
```shell
pip install napari-plugin-engine
```
## Usage
see [documentation](https://napari-plugin-engine.readthedocs.io/en/latest/usage.html)
|
