A terminal for JupyterLite.
- JupyterLite >= 0.4.0
To install the extension, execute:
pip install jupyterlite-terminalYou will also need to install the JupyterLite CLI:
python -m pip install --pre jupyterlite-coreAfter installing jupyterlite-core and jupyterlite-terminal, create a jupyter-lite.json file with the following content to activate the terminal extension:
{
"jupyter-lite-schema-version": 0,
"jupyter-config-data": {
"terminalsAvailable": true
}
}Then build a new JupyterLite site:
jupyter lite buildIf you would like to deploy a JupyterLite site with the terminal extension, you will need to configure your server to add the Cross-Origin-Embedder-Policy and Cross-Origin-Opener-Policy headers.
As an example, this repository deploys the JupyterLite terminal to Vercel, using the following files:
vercel.json: configure the COOP / COEP server headersdeploy/requirements-deploy.txt: dependencies for the JupyterLite deploymentdeploy/deploy.sh: script to deploy to Vercel, using micromamba to have full control on the Python versions and isolate the build in a virtual environment
For more information, have a look at the JupyterLite documentation: https://jupyterlite.readthedocs.io/
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 jupyterlite_terminal 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 buildYou 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 labThen build a JupyterLite distribution with the extension installed:
cd deploy
jupyter lite build --contents contentsAnd serve it either using:
npx static-handler --cors --coop --coep --corp _output/or:
jupyter lite serve --LiteBuildConfig.extra_http_headers=Cross-Origin-Embedder-Policy=require-corp --LiteBuildConfig.extra_http_headers=Cross-Origin-Opener-Policy=same-originThe extra HTTP headers are require to ensure that SharedArrayBuffer is available.
See RELEASE
