Henanigans theme for Jupyter Lab.

See documentation for details.

pip install jupyterlab_henanigans

1. Install docker-desktop
2. docker pull theNewFlesh/jupyterlab_henanigans:[version]

1. Install docker-desktop
2. Ensure docker-desktop has at least 4 GB of memory allocated to it.
3. git clone git@github.com:theNewFlesh/jupyterlab_henanigans.git
4. cd jupyterlab_henanigans
5. chmod +x bin/jupyterlab_henanigans
6. bin/jupyterlab_henanigans docker-start

The service should take a few minutes to start up.

Run bin/jupyterlab_henanigans --help for more help on the command line tool.

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

pip uninstall jupyterlab_henanigans

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 @theNewFlesh/jupyterlab_henanigans within that folder.

1. bin/jupyterlab_henanigans must be run from this repository's top level directory.

2. Therefore, if using zsh, it is recommended that you paste the following line in your ~/.zshrc file:

   • alias jupyterlab_henanigans="cd [parent dir]/jupyterlab_henanigans; bin/jupyterlab_henanigans"
   • Replace [parent dir] with the parent directory of this repository

3. Running the zsh-complete command will enable tab completions of the cli commands, in the next shell session.

   For example:

   • jupyterlab_henanigans [tab] will show you all the cli options, which you can press tab to cycle through
   • jupyterlab_henanigans docker-[tab] will show you only the cli options that begin with "docker-"

This repository contains a suite commands for the whole development process. This includes everything from testing, to documentation generation and publishing pip packages.

These commands can be accessed through:

• The VSCode task runner
• The VSCode task runner side bar
• A terminal running on the host OS
• A terminal within this repositories docker container

Running the zsh-complete command will enable tab completions of the CLI. See the zsh setup section for more information.

Development commands are grouped by one of 10 prefixes:

Here are some frequently used commands to get you started:

bin/jupyterlab_henanigans is a command line interface (defined in cli.py) that works with any version of python 2.7 and above, as it has no dependencies. Commands generally do not expect any arguments or flags.

Its usage pattern is: bin/jupyterlab_henanigans COMMAND [-a --args]=ARGS [-h --help] [--dryrun]

The following is a complete list of all available development commands: