npe20.7.7
npe20.7.7
Published
napari plugin engine v2
pip install npe2
Package Downloads
Authors
Project URLs
Requires Python
>=3.8
Dependencies
- appdirs
- build
>=1
- psygnal
>=0.3.0
- pydantic
- pyyaml
- rich
- tomli-w
- tomli
; python_version < "3.11"
- typer
- black
; extra == "dev"
- ipython
; extra == "dev"
- isort
; extra == "dev"
- mypy
; extra == "dev"
- pre-commit
; extra == "dev"
- jinja2
; extra == "docs"
- magicgui
>=0.3.3; extra == "docs"
- jsonschema
; extra == "json"
- jsonschema
; extra == "testing"
- magicgui
; extra == "testing"
- napari-plugin-engine
; extra == "testing"
- napari-svg
==0.1.5; extra == "testing"
- numpy
; extra == "testing"
- pytest
; extra == "testing"
- pytest-cov
; extra == "testing"
- pytest-pretty
; extra == "testing"
npe2
napari plugin refactor
see also https://github.com/napari/napari/issues/3115
Documentation
For documentation on authoring npe2 plugins, see the napari plugin docs. These include:
- the manifest reference
- the contribution guide
Command line tool
Includes a command line tool npe2
with the following commands:
Commands:
cache Cache utils
convert Convert first generation napari plugin to new (manifest) format.
parse Show parsed manifest as yaml
validate Validate manifest for a distribution name or manifest filepath.
examples:
# convert current directory to an npe2-ready plugin
# (note: the repo must also be installed and importable in the current environment)
npe2 convert .
npe2 validate your-plugin-package
npe2 parse your-plugin-package