Repository files navigation

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

• Push GitHub commits from JupyterLab
• Create GitHub pull request from JupyterLab

• JupyterLab 2.x or 3.x
• Git (runninggit on cmdline or terminal should work)

pip install --upgrade jupyterlab_gitplusjupyter labextension install @reviewnb/jupyterlab_gitplusjupyter serverextensionenable --py jupyterlab_gitplus

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

• Head overdeveloper settings on GitHub. Click "Generate New Token".
• Selectrepo scope. Click "Generate Token". Copy the generated token.
• If~/.jupyter/jupyter_notebook_config.pydoes not exist then create one by runningjupyter 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.

If your organization has a self-hosted ReviewNB instance running at e.g.https://reviewnb.yourdomain.com. You can configureGitPlus to link users to PRs/commits at this URL instead of the default one as follows:

c.GitPlus.self_hosted_reviewnb_endpoint="https://reviewnb.yourdomain.com/"

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

In future GitPlus will be able to,

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

Thejlpm command is JupyterLab's pinned version ofyarn that is installed with JupyterLab. You may useyarn ornpm in lieu ofjlpm below.

# Clone the repo to your local environment & install dependencies# via https://jupyterlab.readthedocs.io/en/stable/extension/extension_tutorial.html#build-and-install-the-extension-for-developmentpip install -ve.# Link your development version of the extension with JupyterLabjupyter labextension link.# Run jupyterlab in watch mode in one terminal tabjupyter lab --watch# Watch the GitPlus source directory in another terminal tabjlpm watch# If you make any changes to server side extension (.py files) then reinstall it from sourcepip install.

If you see any problem, open an issue or send a pull request. You can write tosupport@reviewnb.com for any questions.