Skip to content

samborba/jupyterlab-extension

 
 

Repository files navigation

@platiagro/jupyterlab-extension

Github Actions Status

A JupyterLab extension that connects to PlatIAgro.

This extension is composed of a Python package named jupyterlab_extension for the server extension and a NPM package named @platiagro/jupyterlab-extension for the frontend extension.

Requirements

  • JupyterLab >= 2.0

Install

Note: You will need NodeJS to install the extension.

pip install git+https://github.com/platiagro/jupyterlab-extension.git
jupyter lab build

Troubleshoot

If you are seeing the frontend extension but it is not working, check that the server extension is enabled:

jupyter serverextension list

If the server extension is installed and enabled but you are not seeing the frontend, check the frontend is installed:

jupyter labextension list

If it is installed, try:

jupyter lab clean
jupyter lab build

Contributing

Set env variables

export DATASETS_ENDPOINT=http://<host:port>
export PROJECTS_ENDPOINT=http://<host:port>

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-extension directory

# Install server extension
pip install -e .
# Register server extension
jupyter serverextension enable --py jupyterlab_extension

# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build

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

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

Uninstall

pip uninstall jupyterlab_extension
jupyter labextension uninstall @platiagro/jupyterlab-extension

Publish to npmjs.org

jlpm login
jlpm publish --access=public

About

A JupyterLab extension that connects to PlatIAgro.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 73.4%
  • Python 18.0%
  • Makefile 4.0%
  • CSS 2.5%
  • JavaScript 2.1%