Skip to main content

JupyterLab extension to create GitHub pull requests

Project description

GitPlus

GitPlus is a JupyterLab plugin for version control of Jupyter notebooks. It can,

  • Create GitHub pull request from JupyterLab
  • Create & push commits to GitHub from JupyterLab

In future it will,

  • Pull changes from GitHub
  • Let you resolve merge conflicts for Jupyter notebooks (without messing with underlying JSON)
  • Let you switch/create branches locally

Demo

Create GitHub Pull Request from JupyterLab

Create GitHub Pull Request from JupyterLab

Push GitHub Commits from JupyterLab

Push GitHub Commits from JupyterLab

Requirements

  • JupyterLab >= 2.0

Install

jupyter labextension install @reviewnb/jupyterlab_gitplus

Contributing

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
# Move to @reviewnb/gitplus directory
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

Uninstall

jupyter labextension uninstall @reviewnb/gitplus

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

jupyterlab_gitplus-0.1.8.tar.gz (4.7 kB view hashes)

Uploaded Source

Built Distribution

jupyterlab_gitplus-0.1.8-py3-none-any.whl (18.0 kB view hashes)

Uploaded Python 3

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