Skip to main content

A python script editor for napari

Project description

napari-script-editor

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.

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.

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-script-editor-0.2.10.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

napari_script_editor-0.2.10-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file napari-script-editor-0.2.10.tar.gz.

File metadata

  • Download URL: napari-script-editor-0.2.10.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for napari-script-editor-0.2.10.tar.gz
Algorithm Hash digest
SHA256 c89dd6032f7571b549f23fc98ff3b393085c096a966fffebcaade0931de28398
MD5 64bcaa6da5d64532a5afe1fd375911df
BLAKE2b-256 3fae733372ec381fd0652edfba2af8dec903320b755f1058ebb1ec4ce97767c7

See more details on using hashes here.

File details

Details for the file napari_script_editor-0.2.10-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_script_editor-0.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 f6a200e0a11d5a7c97377af399d871fdba6bbd8973c08e40bc3335e002b8e6aa
MD5 882be199b6e66b38cb20faf3d12ba3c8
BLAKE2b-256 18cf069b67fee7febb79c1692ed54e0b9da7264708e43f0154c5d4b6e7b9cfea

See more details on using hashes here.

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