sachin235 / JhubBitbucketPush

JhubBitbucketPush

JhubBitbucketPush is a jupyter notebook extension enabling users push ipython notebooks to a Bitbucket repo directly from the JupyterHub. The bitbucket button gets displayed in the notebook toolbar. After saving any notebook the user can push notebook to the pre-specified Bitbucket repository. There are few environment variables that must be exported. Feel free to use the extension and open issue if you face any problems, or wish to add some utility to the extension.

Installation

You can currently install this directly from git. Use the following commands to install the extension.

pip install git+https://github.com/sachin235/JhubBitbucketPush.git
jupyter serverextension enable --py JhubBitbucketPush
jupyter nbextension install --py JhubBitbucketPush --user

To enable this extension for all notebooks:

jupyter nbextension enable JhubBitbucketPush --user --py 

Add the following code to jupyterhub_config.py to export the environment variables

import os
for var in os.environ:
    c.Spawner.env_keep.append(var)

Steps

• Install package using the above commands
• Create Bitnucket repo (eg. gitjupyter) where notebooks will be pushed if not already exists and clone it in your GIT_PARENT_DIR
• Clone this repo as well in your GIT_PARENT_DIR directory
• GIT_PARENT_DIR refers to the home directory of your system
• Replace the values in env.sh present in this repo itself (as shown in the example below)
• Run the command source ~/JhubBitbucketPush/env.sh
• Configure ssh key (present in ~/.ssh/id_rsa.pub or specified location) in the Bitbucket account

• Run jupyterhub using the jupyterhub_config.py file that you have updated using the command
  jupyterhub -f /<path to jupyterhub_config.py>/jupyterhub_config.py

Example git configuration

export GIT_PARENT_DIR=~
export GIT_REPO_NAME=gitjupyter
export GIT_BRANCH_NAME=<Branch name>
export GIT_USER=<your Bitbucket username>
export GIT_EMAIL=<your email linked with Bitbucket account>
export BITBUCKET_APP_PASSWORD=<app-password generated from Bitbucket user settings>
export GIT_USER_UPSTREAM=<your Bitbucket username>