jupyterlab-gitplus 0.3.4
JupyterLab extension to create GitHub pull requests
Requires Python: >=3
Keywords: github, jupyter, notebook, pull request, version control, git

# 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

[![Create GitHub Pull Request from JupyterLab](https://github.com/ReviewNB/jupyterlab-gitplus/raw/master/images/PR_thumbnail_v2.png)](https://www.youtube.com/watch?v=yuvLgIjCq48)

### Push GitHub Commits from JupyterLab

[![Push GitHub Commits from JupyterLab](https://github.com/ReviewNB/jupyterlab-gitplus/raw/master/images/Commit_thumbnail_v1.png)](https://www.youtube.com/watch?v=bmca1EBNpvI)

## Requirements

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

## Install
#### 1. Install Required Packages
```bash
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](https://github.com/settings/tokens). 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
```bash
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.

#### 3. [OPTIONAL] Only required for self-hosted ReviewNB customers 

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

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

## FAQ
<details>
  <summary>Where is pull request (PR) opened in case of forked repositories?</summary>
  <p>

  If your repository is forked from another repository (parent) then PR will be created on parent repository.
</p></details>

<details>
  <summary> Which is the <tt>base</tt> branch used in a pull request? </summary>
  <p>

  `base` branch in a PR is a branch against which your changes are compared and ultimately merged. We use repository's default    branch (usually called `master`) as `base` branch of PR. We use parent repository's default branch as `base` in case of forked repo.
</p></details>

<details>
  <summary>Which is the <tt>head</tt> branch used in a pull request?</summary>
  <p>

  `head` branch in a PR is a branch which contains the latest changes you've made. We create a new branch (e.g. `gitplus-xyz123`) as `head` branch. It only contains changes from the files you wish to include in the PR.
</p></details>

<details>
  <summary>How can I edit a pull request opened with GitPlus?</summary>
  <p>

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
</p></details>

<details>
  <summary>Is GitPlus tied to ReviewNB in any way?</summary>
  <p>

  No. GitPlus is it's own open source project. The only connection with ReviewNB is that at the end of PR/Commit creation, GitPlus shows ReviewNB URL along with GitHub URL. You can safely ignore these URLs if you don't want to use ReviewNB.

  It's is useful to see [visual notebook diffs](https://uploads-ssl.webflow.com/5ba4ebe021cb91ae35dbf88c/5ba93ded243329a486dab26e_sl-code%2Bimage.png) on ReviewNB instead of hard to read [JSON diffs](https://uploads-ssl.webflow.com/5ba4ebe021cb91ae35dbf88c/5c24ba833c78e57d6b8c9d09_Screenshot%202018-12-27%20at%204.43.09%20PM.png) on GitHub. [ReviewNB](https://www.reviewnb.com/) also facilitates discussion on notebooks cells.
</p></details>

<details>
  <summary>What if I don't have a ReviewNB account?</summary>
  <p>

  No problem, everything in GitPlus will still work fine. Only the ReviewNB URLs won't work for you.
<p></details>


<details>
  <summary>Can we use GitPlus with Gitlab/BitBucket or any other platforms?</summary>
  <p>

  No, currently we only support repositories on GitHub.
<p></details>

## 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](https://www.reviewnb.com/) - Code review tool for Jupyter notebooks
- [treon](https://github.com/reviewnb/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](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.

```bash
# 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 .
```

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