0.1.0 • Published 4 years ago

@melsylon/jupyterlab_apod v0.1.0

Weekly downloads
1
License
BSD-3-Clause
Repository
github
Last release
4 years ago

jupyterlab_apod

Github Actions Status

A JupyterLab extension.

Requirements

  • JupyterLab >= 2.0

Install

Note: You will need NodeJS to install the extension.

pip install jupyterlab_apod

Contributing

Install

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
# Move to jupyterlab_apod directory
# Install package
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop .
# Rebuild Typescript source after making changes
jlpm build

You can watch the source directory and run JupyterLab to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in one terminal tab
jupyter lab

Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).

Uninstall

pip uninstall jupyterlab_apod
jupyter labextension uninstall @melsylon/jupyterlab_apod