Skip to content

Add additional info about using direct entry for any package #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TimMonko wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −4
Open

Add additional info about using direct entry for any package #213

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,14 +104,27 @@ a restart to be properly configured.

![Screenshot of the napari-plugin-manager showing the process of installing a plugin](https://raw.githubusercontent.com/napari/napari-plugin-manager/main/images/install.png)

### Installing a plugin via direct entry
### Installing via direct entry

You can also install a napari plugin or any other package via the direct entry option. The following steps
correspond to the options and buttons located at the **bottom of the dialog**.
You can also use the direct entry option to install a napari plugin or any
other package that `pip` or `conda` can resolve in the current environment.
Comment on lines +109 to +110
Copy link
Copy Markdown
Member

@psobolewskiPhD psobolewskiPhD May 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe worth emphasizing?

Suggested change
You can also use the direct entry option to install a napari plugin or any
other package that `pip` or `conda` can resolve in the current environment.
You can also use the direct entry option to install a napari plugin or *any
other package* that `pip` or `conda` can resolve in the current environment.

Frankly I'd even consider putting it in an admonition, but not a blocker.

The plugin manager uses the same environment as the running napari application,
so packages installed this way are added alongside your existing napari setup.
This is useful when a plugin or gallery example needs extra dependencies.

For example, you can use the direct entry field to install:

- a regular package name such as `scikit-image`
- extras such as `napari[gallery]`
- a version-pinned requirement such as `xarray==2025.1.0`
- a URL or local archive supported by your selected installer

The following steps correspond to the options and buttons located at the
**bottom of the dialog**.

1. You can type either the name of the package, a url to the resource or drag and drop a compressed file
of a previously downloaded package.
2. Select the tool (`conda` or `pip`) by clicking on the arrow dorpdown of the `Install` button.
2. Select the tool (`conda` or `pip`) by clicking on the arrow dropdown of the `Install` button.
3. Start the installation process by clicking on the `Install` button.

You can cancel the process at any time by clicking the `Cancel all` button.
Expand Down
Loading