A terminal for JupyterLite.
⚠️ This extension is still in development and not yet ready for general use. ⚠️
To install the extension, execute:
pip install jupyterlite-terminal
You will also need to install the JupyterLite CLI:
python -m pip install --pre jupyterlite-core
After 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 build
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 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
Then build a JupyterLite distribution with the extension installed:
jupyter lite build
And serve it:
jupyter lite serve
See RELEASE