A plugin that adds a console to napari
Project description
napari-console (WIP, under active development)
A plugin that adds a console to napari
This napari plugin was generated with Cookiecutter using with @napari's cookiecutter-napari-plugin template.
Local variables
In napari-console 0.0.8 and earlier, the console locals()
namespace only
contained a reference to the napari viewer that enclosed the console.
Since version 0.0.9, it instead contains everything in the enclosing frame that called napari. That is, if your Python code is:
import napari
import numpy as np
from scipy import ndimage as ndi
image = np.random.random((500, 500))
labels = ndi.label(image > 0.7)[0]
viewer, image_layer = napari.imshow(image)
labels_layer = viewer.add_labels(labels)
napari.run()
Then the napari console will have the variables np
, napari
, ndi
, image
,
labels
, viewer
, image_layer
, and labels_layer
in its namespace.
This is implemented by inspecting the Python stack when the console is first
instantiated, finding the first frame that is outside of the napari_console
,
napari
, and in_n_out
modules, and passing the variables in the frame's
f_locals
and f_globals
to the console namespace.
If you want to disable this behavior (for example, because you are embedding
napari and the console within some larger application), you can add
NAPARI_EMBED=1
to your environment variables before instantiating the
console.
Installation
You can install napari-console
via pip:
pip install napari-console
Contributing
Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.
License
Distributed under the terms of the BSD-3 license, "napari-console" is free and open source software
Issues
If you encounter any problems, please file an issue along with a detailed description.
Project details
Release history Release notifications | RSS feed
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
Hashes for napari_console-0.1.0a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 221b9e443e1ebc5921f9ec0a5ca5f1644c5c20588d1cb13af69acaef35731a89 |
|
MD5 | cd5cc3bf24744c28b24b76dc6aa183da |
|
BLAKE2b-256 | 87a4f59d2cdfc7ec01af3501284ee23b890218f31c22a4fbb5f29f5fe6e56995 |