napari-script-editor

napari-script-editor

A python script editor for napari

License PyPI Python Version tests codecov napari hub

A python script editor for napari based on haesleinhuepf's fork of PyQode.


This napari plugin was generated with Cookiecutter using with @napari's cookiecutter-napari-plugin template.

Usage

Start the script editor from the menu Tools > Scripts > Script Editor. Use the auto-completion while typing, check out the napari tutorials and the example scripts. Use the Run button to execute a script.

If you save the script to the folder ".napari-scripts" in your home directory, you will find the script in the Tools > Scripts menu in napari. You can then also start it from there.

Note: If you have scripts, that might be useful to others, please send them as pull-request to the examples in repository or share them in any other way that suits you.

Installation

  • Get a python environment, e.g. via mini-conda. If you never used python/conda environments before, please follow the instructions here first.
  • Install napari using conda.
conda install -c conda-forge napari

Afterwards, install napari-script-editor using pip:

pip install napari-script-editor

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-script-editor" is free and open source software

Known issues

  • Sometimes, the script editor thinks, the file has been changed on disk and asks to reload it.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Version:

  • 0.2.9

Last updated:

  • 06 October 2022

First released:

  • 06 November 2021

License:

  • BSD-3-Clause

Supported data:

  • Information not submitted

Plugin type:

GitHub activity:

  • Stars: 11
  • Forks: 0
  • Issues + PRs: 4

Python versions supported:

Operating system:

Requirements:

  • napari-plugin-engine (>=0.1.4)
  • numpy
  • napari
  • haesleinhuepf-pyqode.core (>=2.15.5)
  • haesleinhuepf-pyqode.python (>=2.15.2)
  • napari-tools-menu
  • jedi (>=0.18.0)
  • pyflakes (<=2.4.0)

Sign up to receive updates