0.1.7 • Published 3 years ago

jhub_scheduler v0.1.7

Weekly downloads
15
License
BSD-3-Clause
Repository
gitlab
Last release
3 years ago

jhub_scheduler

Github Actions StatusBinder

schedule a notebook job in the TTSS

This extension is composed of a Python package named jhub_scheduler for the server extension and a NPM package named jhub_scheduler for the frontend extension.

Requirements

  • JupyterLab >= 2.0

Install

pip install jhub_scheduler

Troubleshoot

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

jupyter server extension list

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

jupyter labextension list

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 jhub_scheduler 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).

Uninstall

pip uninstall jhub_scheduler
jupyter labextension uninstall jhub_scheduler