A python script editor for napari
Project description
napari-script-editor
A python script editor for napari based on 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
You can install napari-script-editor
via pip:
pip install napari-script-editor
To install latest development version :
pip install git+https://github.com/haesleinhuepf/napari-script-editor.git
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
napari-script-editor
depends on the auto-completion libraryjedi<=0.17.2
in an slightly outdated version of jedi. Thus, it is recommended to not use it in environments, where you also use jupyter-notebooks that may require a more recent version ofjedi
.- 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.