@reviewnb/jupyterlab_gitplus NPM

GitPlus

A JupyterLab plugin for version control of Jupyter notebooks. It can,

Push GitHub commits from JupyterLab
Create GitHub pull request from JupyterLab

Demo

Create GitHub Pull Request from JupyterLab

Push GitHub Commits from JupyterLab

Requirements

JupyterLab 2.x or 3.x
Git (running git on cmdline or terminal should work)

Install

1. Install Required Packages

pip install --upgrade jupyterlab_gitplus
jupyter labextension install @reviewnb/jupyterlab_gitplus
jupyter serverextension enable --py jupyterlab_gitplus

2. Setup GitHub token

Tokens are required to make API calls to GitHub to push commits and create pull requests.

Head over developer settings on GitHub. Click "Generate New Token".
Select repo scope. Click "Generate Token". Copy the generated token.
If ~/.jupyter/jupyter_notebook_config.py does not exist then create one by running jupyter notebook --generate-config
Open you Jupyter config file ~/.jupyter/jupyter_notebook_config.py & paste the token as shown below

c.GitPlus.github_token = '<your-github-access-token>'

After installation, start JupyterLab normally & you should see "Git-Plus" as a new menu item at the top.

FAQ

You can head over to GitHub and edit the PR metadata to your liking. For pushing additional file changes to the same PR, 1. Copy the branch name from GitHub UI (e.g. gitplus-xyz123) 2. Checkout that branch locally 3. Make the file changes you want 4. Use push commit functionality from GitPlus to push new changes

Motivation

Our aim is to make notebooks a first class entity in Data science & ML teams. We can achieve this by making notebooks play well with existing tools & processes instead of building expensive proprietary platforms. Other projects in this direction are,

ReviewNB - Code review tool for Jupyter notebooks
treon - Easy to use test framework for Jupyter notebooks

Roadmap

In future GitPlus will be able to,

Pull changes from GitHub
Switch/create branches locally
Resolve notebook merge conflicts (without messing with underlying JSON)

Development

Install

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 & install dependencies

# Link your development version of the extension with JupyterLab
jupyter labextension link .

# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

# Watch the GitPlus source directory in another terminal tab
jlpm watch

# If you make any changes to server side extension (.py files) then reinstall it from source
pip install .