Install & Compatibility
Where this runs
tested against v0.1.4 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
496MB installed
● package 496MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
napari_console
✓ import napari_console
✗ import napari_console
This quickstart demonstrates how to launch napari and then access the napari-console plugin through the GUI. The plugin integrates directly into the napari environment, providing an interactive Python shell with the `viewer` object pre-injected into its namespace.
import napari
# Ensure both napari and napari-console are installed:
# pip install napari napari-console
# 1. Start the napari viewer
viewer = napari.Viewer()
# 2. To open the console, in the running napari application:
# Go to 'Plugins' in the top menu bar.
# Select 'napari-console: Console'.
# A new console widget will appear, automatically providing access to the 'viewer' object.
# Example commands to type directly into the napari console:
# print(viewer)
# viewer.add_points([[0, 0], [10, 10], [5, 5]], text='Hello')
# Keep napari running (essential for GUI interaction)
napari.run()
Debug
Known issues
gotchanapari-console requires specific versions of `napari` and `qtconsole`. Ensure your environment satisfies `napari>=0.4.17` and `qtconsole>=5.3.0` to avoid display issues or errors.fixUpgrade napari-console and ensure all dependencies are up-to-date: `pip install --upgrade napari-console napari qtconsole`.
affects: <0.1.1 (napari-console) with older napari
gotchaThe console is a GUI element and must be explicitly opened via the 'Plugins' menu in the napari application. It does not automatically appear on napari startup.fixAfter launching napari, navigate to `Plugins > napari-console: Console` in the napari menu bar to open the console window.
affects: All versions
gotchaThe console operates within the context of the running napari viewer. While `viewer` is automatically available, other Python objects or variables defined in scripts *outside* the napari process will not be accessible unless explicitly imported or redefined within the console.fixTo access external variables or modules, import them directly within the console session (e.g., `import numpy as np`) or pass objects to the napari viewer's namespace if you're embedding (advanced use case).
affects: All versions
gotchaIssues with `qtconsole` (e.g., version conflicts with other packages, missing `ipython` kernels, or display issues on specific Qt backends) can directly impact napari-console's functionality or prevent it from launching.fixVerify your `qtconsole` installation and its dependencies are working correctly. Try running `jupyter qtconsole` directly from your terminal to diagnose `qtconsole`-specific issues. Ensure `pip install --upgrade qtconsole` is run.
affects: All versions
Upgrade
Version history
0.1.4latest on PyPI · released Oct 15, 2025
Audit
Dependencies
naparirequiredCore dependency for the plugin to function within the napari ecosystem. Requires napari>=0.4.17.
qtconsolerequiredPowers the interactive console functionality. Requires qtconsole>=5.3.0.