{"name":"napari-ui-tracer","display_name":"Napari UI tracer","visibility":"public","icon":"","categories":[],"schema_version":"0.2.0","on_activate":null,"on_deactivate":null,"contributions":{"commands":[{"id":"napari-ui-tracer.make_qwidget","title":"Make Napari UI tracer widget","python_name":"napari_ui_tracer._widget:QtNapariUITracer","short_title":null,"category":null,"icon":null,"enablement":null}],"readers":null,"writers":null,"widgets":[{"command":"napari-ui-tracer.make_qwidget","display_name":"Napari UI tracer widget","autogenerate":false}],"sample_data":null,"themes":null,"menus":{},"submenus":null,"keybindings":null,"configuration":[]},"package_metadata":{"metadata_version":"2.1","name":"napari-ui-tracer","version":"0.1.2","dynamic":null,"platform":null,"supported_platform":null,"summary":"A plugin to help understand Napari UI components and check their source code definition","description":"# napari-ui-tracer\n\n[![License MIT](https://img.shields.io/pypi/l/napari-ui-tracer.svg?color=green)](https://github.com/dalthviz/napari-ui-tracer/raw/main/LICENSE)\n[![Python Version](https://img.shields.io/pypi/pyversions/napari-ui-tracer.svg?color=green)](https://python.org)\n[![PyPI](https://img.shields.io/pypi/v/napari-ui-tracer.svg?color=green)](https://pypi.org/project/napari-ui-tracer)\n[![PyPI download month](https://img.shields.io/pypi/dm/napari-ui-tracer.svg?color=green)](https://pypi.org/project/napari-ui-tracer/)\n[![conda version](https://img.shields.io/conda/vn/conda-forge/napari-ui-tracer.svg?color=blue)](https://anaconda.org/conda-forge/napari-ui-tracer)\n[![conda download count](https://img.shields.io/conda/d/conda-forge/napari-ui-tracer.svg?color=blue)](https://anaconda.org/conda-forge/napari-ui-tracer)\n[![tests](https://github.com/dalthviz/napari-ui-tracer/workflows/tests/badge.svg)](https://github.com/dalthviz/napari-ui-tracer/actions)\n[![codecov](https://codecov.io/gh/dalthviz/napari-ui-tracer/branch/main/graph/badge.svg?token=E6je6vXOSA)](https://codecov.io/gh/dalthviz/napari-ui-tracer)\n[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-ui-tracer)](https://napari-hub.org/plugins/napari-ui-tracer)\n\nA plugin to help understand Napari UI components and locate their code definition\n\n----------------------------------\n\nThis [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.\n\n![GIF showing Napari UI tracer's functionality](https://raw.githubusercontent.com/dalthviz/napari-ui-tracer/main/images/napari-ui-tracer.gif)\n\n## Installation\n\nYou can install `napari-ui-tracer` via [pip]:\n\n    pip install napari-ui-tracer\n\nOr via [conda]:\n\n    conda install -c conda-forge napari-ui-tracer\n\nTo install latest development version :\n\n    pip install git+https://github.com/dalthviz/napari-ui-tracer.git\n\n## Usage\n\n1. Show the plugin inside the napari interface:\n\n    * You can launch napari with the plugin visible running:\n\n            napari -w napari-ui-tracer\n\n    * Or select it from `Plugins > Napari UI tracer widget`\n\n2. Check the `Enable Qt event filter` checkbox:\n    * Use `Ctrl/Cmd + Mouse button right click` to see the information available about any widget inside napari\n    * An option to show objects documentation (object class docstring) can be used by checking the `Show object documentation` checkbox\n\n3. Check the `Enable application events logging` checkbox:\n    * A log like information with the events generated when interacting with the application will appear\n    * Some configuration options are available:\n        * `Stack depth`: Stack depth to show. Default to 20\n        * `Allowed nested events`: How many sub-emit nesting levels to show (i.e. events that get triggered by other events). Default to 0\n\n4. 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)\n\n## Contributing\n\nContributions are very welcome. Pre-commit is used for formatting. Tests can be run with [tox], please ensure\nthe coverage at least stays the same before you submit a pull request.\n\n## License\n\nDistributed under the terms of the [MIT] license,\n\"napari-ui-tracer\" is free and open source software\n\n## Issues\n\nIf you encounter any problems, please [file an issue] along with a detailed description.\n\n[napari]: https://github.com/napari/napari\n[Cookiecutter]: https://github.com/audreyr/cookiecutter\n[@napari]: https://github.com/napari\n[MIT]: http://opensource.org/licenses/MIT\n[BSD-3]: http://opensource.org/licenses/BSD-3-Clause\n[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt\n[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt\n[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0\n[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt\n[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin\n\n[file an issue]: https://github.com/dalthviz/napari-ui-tracer/issues\n\n[napari]: https://github.com/napari/napari\n[tox]: https://tox.readthedocs.io/en/latest/\n[pip]: https://pypi.org/project/pip/\n[PyPI]: https://pypi.org/\n[conda]: https://docs.conda.io/projects/conda/en/stable/\n","description_content_type":"text/markdown","keywords":null,"home_page":"https://github.com/dalthviz/napari-ui-tracer","download_url":null,"author":"Daniel Althviz","author_email":"dalthviz@gmail.com","maintainer":null,"maintainer_email":null,"license":"MIT","classifier":["Development Status :: 2 - Pre-Alpha","Framework :: napari","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: 3.10","Topic :: Scientific/Engineering :: Image Processing"],"requires_dist":["qtpy (>=2.3.0)","pre-commit ; extra == 'pre-commit'","pyqt5 ; extra == 'pyqt5'","tox ; extra == 'testing'","pytest ; extra == 'testing'","pytest-cov ; extra == 'testing'","pytest-qt ; extra == 'testing'","napari ; extra == 'testing'"],"requires_python":">=3.8","requires_external":null,"project_url":["Bug Tracker, https://github.com/dalthviz/napari-ui-tracer/issues","Documentation, https://github.com/dalthviz/napari-ui-tracer#README.md","Source Code, https://github.com/dalthviz/napari-ui-tracer","User Support, https://github.com/dalthviz/napari-ui-tracer/issues"],"provides_extra":["pre-commit","pyqt5","testing"],"provides_dist":null,"obsoletes_dist":null},"npe1_shim":false}