https://github.com/napari/npe2
napari plugin engine v2
https://github.com/napari/npe2
napari plugins
Last synced: 5 months ago
JSON representation
napari plugin engine v2
- Host: GitHub
- URL: https://github.com/napari/npe2
- Owner: napari
- License: other
- Created: 2021-08-01T20:49:42.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T17:32:31.000Z (5 months ago)
- Last Synced: 2025-05-07T07:06:54.093Z (5 months ago)
- Topics: napari, plugins
- Language: Python
- Homepage: https://napari.org/plugins/
- Size: 612 KB
- Stars: 13
- Watchers: 12
- Forks: 29
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# npe2 - napari plugin engine version 2
[](https://github.com/napari/npe2/actions/workflows/ci.yml)
[](https://codecov.io/gh/napari/npe2)
## Project description
The **napari plugin engine version 2**, **npe2** extends the functionality of
[napari's core](https://github.com/napari/napari).
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](https://napari.org/stable/plugins/index.html)
offers comprehensive information for **plugin users** and for **plugin developers**.
### Plugin users
For plugin users, the docs include information about:
- [Starting to use plugins](https://napari.org/stable/plugins/start_using_plugins/index.html#plugins-getting-started)
- [Finding and installing plugins](https://napari.org/stable/plugins/start_using_plugins/finding_and_installing_plugins.html#find-and-install-plugins)
### Plugin developers
For plugin developers, the docs cover topics like:
- [Building a plugin](https://napari.org/stable/plugins/building_a_plugin/index.html)
- [Guides to different plugin contributions](https://napari.org/stable/plugins/building_a_plugin/guides.html)
- [Technical references such as the plugin manifest](https://napari.org/stable/plugins/technical_references/manifest.html)
Try the [**napari plugin template**](https://github.com/napari/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
1. Create and activate a virtual environment.
*If you are new to using virtual environments, visit our [virtual environments guide](https://napari.org/stable/plugins/virtual_environment_docs/1-virtual-environments.html)*.
```bash
python3 -m venv .venv
source .venv/bin/activate
```
2. Install npe2.
```bash
pip install npe2
```
3. Test your installation.
```bash
npe2 --help
```
### Using conda
1. Create and activate a virtual environment.
```bash
conda create -n npe-test -c conda-forge python=3.12
conda activate npe-test
```
2. Install npe2.
```bash
conda install npe2
```
3. Test your installation.
```bash
npe2 --help
```
## Usage
The command line tool `npe2` offers the following commands:
```bash
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:
```bash
npe2 list
```
Compile a source directory to create a plugin manifest:
```bash
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.):
```bash
npe2 convert .
```
Validate a plugin package. For example, a plugin named `your-plugin-package`:
```bash
npe2 validate your-plugin-package
```
Show a parsed manifest of your plugin:
```bash
npe2 parse your-plugin-package
```
## License
npe2 uses the [BSD License](./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](https://napari.org/stable/community/index.html)
or [open a new issue on this repo](https://github.com/napari/npe2/issues/new).