npe2 - napari plugin engine version 2
Project description
The napari plugin engine version 2, npe2 extends the functionality of napari's core. The plugin ecosystem offers user additional functionality for napari as well as specific support for different scientific domains.
This repo contains all source code and documentation required for defining, validating and managing plugins for napari.
Getting started
The napari plugin docs landing page offers comprehensive information for plugin users and for plugin developers.
Plugin users
For plugin users, the docs include information about:
Plugin developers
For plugin developers, the docs cover topics like:
- Building a plugin
- Guides to different plugin contributions
- Technical references such as the plugin manifest
Try the napari plugin template to streamline development of a new plugin.
Installation
The npe2 command line tool can be installed with pip or conda, but will already be installed as a dependency if you have napari installed.
Using pip
- Create and activate a virtual environment.
If you are new to using virtual environments, visit our virtual environments guide.
```bash
python3 -m venv .venv
source .venv/bin/activate
```
-
Install npe2.
pip install npe2
-
Test your installation.
npe2 --help
Using conda
-
Create and activate a virtual environment.
conda create -n npe-test -c conda-forge python=3.12 conda activate npe-test
-
Install npe2.
conda install npe2
-
Test your installation.
npe2 --help
Usage
The command line tool npe2 offers the following commands:
cache Cache utils
compile Compile @npe2.implements contributions to generate a manifest.
convert Convert first generation napari plugin to new (manifest) format.
fetch Fetch manifest from remote package.
list List currently installed plugins.
parse Show parsed manifest as yaml.
validate Validate manifest for a distribution name or manifest filepath.
Examples
List currently installed plugins:
npe2 list
Compile a source directory to create a plugin manifest:
npe2 compile PATH_TO_SOURCE_DIRECTORY
Convert current directory to an npe2-ready plugin (note: the repo must also be installed and importable in the current environment.):
npe2 convert .
Validate a plugin package. For example, a plugin named your-plugin-package:
npe2 validate your-plugin-package
Show a parsed manifest of your plugin:
npe2 parse your-plugin-package
License
npe2 uses the BSD License.
History
This repo replaces the initial napari plugin engine v1. See also https://github.com/napari/napari/issues/3115 for motivation and technical discussion about the creation of v2.
Contact us
Visit our community documentation or open a new issue on this repo.
5 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file npe2-0.9.0.tar.gz.
File metadata
- Download URL: npe2-0.9.0.tar.gz
- Upload date:
- Size: 129.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
70014cad1b61c2defdf7b8ee19a1e047333368ec71dd8139a770bf062afeeff3
|
|
| MD5 |
fb097a34642dd054be4b8906e926daae
|
|
| BLAKE2b-256 |
c0a81b8a59b9554b6491182816725a7e3f3ceddc9c97e4f585ff49213b0fec58
|
File details
Details for the file npe2-0.9.0-py3-none-any.whl.
File metadata
- Download URL: npe2-0.9.0-py3-none-any.whl
- Upload date:
- Size: 95.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d6db6dc37eebdd54b3c90b3eaeaa11a37f6dd0e9c8cc3f8b67c9a0e64e9e3ad0
|
|
| MD5 |
f9d1c0c918de5ef184821a1f66a69bfc
|
|
| BLAKE2b-256 |
8db15e0b586573ed6c5d4c497032d0d52780d597517e4f2ecfc13e63cfb364b3
|
