A plugin to help understand Napari UI components and check their source code definition
Project description
napari-ui-tracer
A plugin to help understand Napari UI components and locate their code definition
This napari plugin was generated with Cookiecutter using @napari's cookiecutter-napari-plugin template.
Installation
You can install napari-ui-tracer
via pip:
pip install napari-ui-tracer
Or via conda:
conda install -c conda-forge napari-ui-tracer
To install latest development version :
pip install git+https://github.com/dalthviz/napari-ui-tracer.git
Usage
-
Show the plugin inside the napari interface:
-
You can launch napari with the plugin visible running:
napari -w napari-ui-tracer
-
Or select it from
Plugins > Napari UI tracer widget
-
-
Check the
Enable Qt event filter
checkbox:- Use
Ctrl/Cmd + Mouse button right click
to see the information available about any widget inside napari - An option to show objects documentation (object class docstring) can be used by checking the
Show object documentation
checkbox
- Use
-
Check the
Enable application events logging
checkbox:- A log like information with the events generated when interacting with the application will appear
- Some configuration options are available:
Stack depth
: Stack depth to show. Default to 20Allowed nested events
: How many sub-emit nesting levels to show (i.e. events that get triggered by other events). Default to 0
-
If you want to explore the related widget or event module source file, click the link in the output section of the plugin (the module file will open if you have a registered program to open such kind of file)
Contributing
Contributions are very welcome. Pre-commit is used for formatting. 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 MIT license, "napari-ui-tracer" 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_ui_tracer-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c63ff88b65b470c7af41c6295d28d373dfc0a991fb121b5b9b02b27b796d3e2 |
|
MD5 | 30ef47c6c907c22d888c821b6568d116 |
|
BLAKE2b-256 | fc1b6eb1457a523f497dbb20f949bd87866b9864ed1ae5633af2cc132c487293 |