classicvalues / jupyterlab_app

A desktop application for JupyterLab, based on Electron.

JupyterLab App

A desktop application for JupyterLab, based on Electron.

Download

Before installing please read the Python Environment Customization Guide if you plan to customize the Python environment to add new packages.

• Debian, Ubuntu Linux Installer
• Red Hat, Fedora, SUSE Linux Installer
• macOS Installer
• Windows Installer

Build dependencies

• conda

  You can install conda as part of a Miniforge installer.

• (conda) Constructor to bundle JupyterLab App Server into the stand-alone application. You can install Constructor using:

  conda install -c conda-forge constructor

• nodejs

  You can install from https://nodejs.org/en/download/ or run:

  conda install -c conda-forge nodejs

• yarn

  Install using

  npm install --global yarn

Local development

JupyterLab App bundles JupyterLab front-end and a conda environment as JupyterLab App Server as its backend into an Electron application.

<platform>: mac, linux or win

• Get the project source code

  git clone https://github.com/jupyterlab/jupyterlab_app.git

• Install dependencies and build JupyterLab App

  yarn
  yarn build

• Create the JupyterLab App Server installer using

  yarn create_env_installer:<platform>

  Installer will be created in one of env_installer/JupyterLabAppServer<version>-MacOSX-x86_64.sh, env_installer/JupyterLabAppServer-<version>-Linux-x86_64.sh, env_installer/JupyterLabAppServer-<version>-Windows-x86_64.exe based on your platform

• Run the installer to install the JupyterLab App Server. Make sure to set install location to jlab_server directory that is at the same level as jupyterlab_app project source code

• Now you can launch the JupyterLab App locally using:

  yarn start

Building for distribution

• Build the application

  yarn run clean && yarn build

• Create JupyterLab App Server installer

  yarn create_env_installer:<platform>

• Create JupyterLab App installer which will also bundle JupyterLab App Server installer.

  yarn dist:<platform>

  App Installer will be created in dist/JupyterLab.pkg (macOS), dist/JupyterLab.deb (Debian, Ubuntu), dist/JupyterLab.rpm (Red Hat, Fedora) and dist/JupyterLab-Setup.exe (Windows) based on the platform

Release Instructions

For instructions on updating bundled JupyterLab packages and cutting a new app release, please follow Release.md document.