fails-components-jupyter-filesystem-extension 0.0.3

A collection of extensions, that redirect's filesystems access to fails and let fails puppeteer Jupyter lite.

fails_components_jupyter_filesystem_extension

This is an extension, that taps into jupyter lite's filesystem handling to be able to remotely control and supply the files visible to jupyter lite. It is probably only useful together with fails-components' jupyter launcher plugin, that allows to control jupyter lite embedded inside an iframe (build from the jupyterfails' repos configs).

Requirements

• JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install fails_components_jupyter_filesystem_extension

Uninstall

To remove the extension, execute:

pip uninstall fails_components_jupyter_filesystem_extension

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 fails_components_jupyter_filesystem_extension directory
jlpm build
# 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 fails_components_jupyter_filesystem_extension

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 @fails-components/jupyter-applet-view within that folder.

Testing the extension

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test