Skip to main content

Mosaic schematic editor lab extension

Project description

jupyterlab_mosaic

Github Actions Status

Mosaic schematic editor lab extension

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install jupyterlab_mosaic

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_mosaic

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_mosaic 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 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 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 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_mosaic

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 jupyterlab-mosaic 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_mosaic-0.1.1.tar.gz (134.8 kB view details)

Uploaded Source

Built Distribution

jupyterlab_mosaic-0.1.1-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_mosaic-0.1.1.tar.gz.

File metadata

  • Download URL: jupyterlab_mosaic-0.1.1.tar.gz
  • Upload date:
  • Size: 134.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for jupyterlab_mosaic-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a6469d8e0b400d93d9761f2dbcb844f39b941c5b4c427b9bb5abe8ec618a2aff
MD5 8ec8e270a367a496a188c7af521c9be0
BLAKE2b-256 d84f9a80c4210c308e3179bf58ea4b5acf45dcf3e61cea3e4e16de10dc8438db

See more details on using hashes here.

File details

Details for the file jupyterlab_mosaic-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_mosaic-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8125928f8138c399b2e14d155fcf441357b390fc8fa6433d756e219378265514
MD5 248325c26c42c2f3f081bf66bf128ca7
BLAKE2b-256 d20191f67db847f0d165babd1a1d973161e491cd958ff7afb95e5d7f27c50568

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