Skip to main content

A terminal for JupyterLite

Project description

jupyterlite-terminal

Github Actions Status lite-badge

A terminal for JupyterLite.

⚠️ This extension is still in development and not yet ready for general use. ⚠️

a screenshot showing a terminal running in JupyterLite

Requirements

  • JupyterLite >= 0.4.0

Install

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

Usage

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

Deployment

If 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 headers
  • requirements-deploy.txt: dependencies for the JupyterLite deployment
  • 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/

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 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 --contents demo/contents

And 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-origin

The extra HTTP headers are require to ensure that SharedArrayBuffer is available.

Packaging the extension

See RELEASE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlite_terminal-0.1.3.tar.gz (598.4 kB view details)

Uploaded Source

Built Distribution

jupyterlite_terminal-0.1.3-py3-none-any.whl (53.6 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlite_terminal-0.1.3.tar.gz.

File metadata

  • Download URL: jupyterlite_terminal-0.1.3.tar.gz
  • Upload date:
  • Size: 598.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for jupyterlite_terminal-0.1.3.tar.gz
Algorithm Hash digest
SHA256 1e59aedf4ffa3e478c8227cc2b0ad2b4171c4e57a9398807d8afd6faa775377c
MD5 568fa3667e8aafad7f1d529999ac7cef
BLAKE2b-256 fe841738cdbe3036a79639097253bd9ac32c60825fe338858b727c6d492d91d5

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlite_terminal-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlite_terminal-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e1f82c11ad85a6872be06311895d6a0a5e9f072a75df43fd9403b86a7892b0fd
MD5 3ec7bc639fda6d3df2220c7e92fc01e4
BLAKE2b-256 fb4951e79bb84e2aeb3bdd0d42fd925cb66d4b70576391f339ebe811eef41879

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page