napari-script-editor

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.

chatGPT support

In case openAI API is installed, you find another button in the script editor to Ask chatGPT. Enter a prompt in the script editor and click the button. The script editor will send the prompt to chatGPT and replace it with the answer. For example try entering:

Write Python code for segmenting an image using these steps:
    * Apply a Gaussian blur
    * Threshold the image using Otsu's method
    * Apply connected component labeling

and it will replace it with code accordingly. If it doesn't work in the first attempt, try again. ChatGPT's answers are not always the same.

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.