Skip to main content

Simple image editor in JupyterLab.

Project description

Image Editor

Extension status BuildBinder

Simple image editor in JupyterLab.

Demo

This extension makes use of material design icons released under Apache License Version 2.0.

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install jupyterlab_image_editor

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_image_editor

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab_image_editor directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

pip uninstall jupyterlab_image_editor

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named image-editor within that folder.

Packaging the extension

See RELEASE

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

jupyterlab_image_editor-0.1.0.tar.gz (423.1 kB view details)

Uploaded Source

Built Distribution

jupyterlab_image_editor-0.1.0-py3-none-any.whl (607.3 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_image_editor-0.1.0.tar.gz.

File metadata

  • Download URL: jupyterlab_image_editor-0.1.0.tar.gz
  • Upload date:
  • Size: 423.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 importlib_metadata/4.6.4 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6

File hashes

Hashes for jupyterlab_image_editor-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8962da985b610c0229e8ba493dc1caaa74b0a1e99f55b31bce23a105219018cf
MD5 1b2868a5f89cf9b3c604c69de423ca03
BLAKE2b-256 5893d449a165361636d239ed4b92d22244c2b2189463014717e0b51ebda0fed5

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_image_editor-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_image_editor-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 607.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 importlib_metadata/4.6.4 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6

File hashes

Hashes for jupyterlab_image_editor-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 51cb6c2d06a4c8ddfb5a64cb0411d34d7f0e5148958f596635d03695d78efe38
MD5 c2f1da33fa180f88dd56e11b6e29be36
BLAKE2b-256 f7f29025f5d6c898f86265df2be06faa5cded012164d7d461890c9e3d4459449

See more details on using hashes here.

Provenance

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