Skip to main content

A plugin to help understand Napari UI components and check their source code definition

Project description

napari-ui-tracer

License MIT Python Version PyPI PyPI download month conda version conda download count tests codecov napari hub

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.

GIF showing Napari UI tracer's functionality

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

  1. 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

  2. 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
  3. 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 20
      • Allowed nested events: How many sub-emit nesting levels to show (i.e. events that get triggered by other events). Default to 0
  4. 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

napari-ui-tracer-0.1.2.tar.gz (10.2 kB view hashes)

Uploaded source

Built Distribution

napari_ui_tracer-0.1.2-py3-none-any.whl (9.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page