A side panel providing information and controls to run Apache Beam notebooks interactively.
- JupyterLab >= 2.0
jupyter labextension install apache-beam-jupyterlab-sidepanel
jlpm command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
npm in lieu of
# Clone the repo to your local environment# Move to apache-beam-jupyterlab-sidepanel directory# Install dependenciesjlpm# Build Typescript sourcejlpm build# Link your development version of the extension with JupyterLabjupyter labextension link .# Rebuild Typescript source after making changesjlpm build# Rebuild JupyterLab after making any changesjupyter 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 tabjlpm watch# Run jupyterlab in watch mode in one terminal tabjupyter lab --watch
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).
To run all tests, under
apache-beam-jupyterlab-sidepanel directory, simply do:
# Make sure all dependencies are installed.jlpm# Run all tests.jlpm jest
This project uses
ts-jest to test all ts/tsx files under
To run a single test, find out the name of a test in the source code that looks like:
jlpm jest -t 'does ABC'
Format and lint
The project uses prettier for formatting and eslint for lint. Prettier is configured as a plugin used by eslint. There are pre-configured yarn scripts to execute them.
# Under apache-beam-jupyterlab-sidepanel directory.# Make sure dependencies are installed.# Prettier and eslint are both installed as dev dependencies.jlpm# Check format and lint issues.jlpm eslint:check# Check then fix in place format and lint issues.jlpm eslint
jupyter labextension uninstall apache-beam-jupyterlab-sidepanel