Skip to content
Create, list, and load GitHub Gists from Jupyter notebooks
Python JavaScript
Branch: master
Clone or download
Latest commit dae052f Mar 29, 2019

README.md

jupyter-notebook-gist

Build Status

codecov

Create a gist from the Jupyter Notebook UI.

Installation

To install, simply run:

pip install jupyter-notebook-gist
jupyter serverextension enable --py jupyter_notebook_gist
jupyter nbextension install --py jupyter_notebook_gist
jupyter nbextension enable --py jupyter_notebook_gist
jupyter nbextension enable --py widgetsnbextension

The last step is needed to enable the widgetsnbextension extension that Jupyter-Notebook-Gist depends on. It may have been enabled before by a different extension.

You may want to append --user to the commands above if you're getting configuration errors upon invoking them.

To double-check if the extension was correctly installed run:

jupyter nbextension list
jupyter serverextension list

To uninstall the extension run:

jupyter serverextension disable --py jupyter_notebook_gist
jupyter nbextension disable --py jupyter_notebook_gist
jupyter nbextension uninstall --py jupyter_notebook_gist
pip uninstall jupyter-notebook-gist

Configuration

After installing, edit your jupyter_notebook_config.py file to specify the GitHub client id and secret.

If your jupyter_notebook_config.py file does not exist, you can create one by running jupyter notebook --generate-config. You can check the location of this file by running jupyter --config-dir.

c.NotebookGist.oauth_client_id = "my_client_id"         # FIXME
c.NotebookGist.oauth_client_secret = "my_client_secret" # FIXME

Replace the vars above with a working GitHub client id and secret. You can create one here.

Here's an example of an OAuth application created by @mreid-moz for testing.

Then run jupyter notebook from the repo root.

Alternatively you can also pass the GitHub client id and secret as command line parameters when you run the notebook (please fill the placeholders accordingly):

jupyter notebook --NotebookGist.oauth_client_id="<my_client_id>" --NotebookGist.oauth_client_secret="<my_client_secret>"

Changelog

Master

  • Buttons for loading gists are now available on the "tree" (file manager) page in Jupyter.

  • IMPORTANT Requires manual step to enable after running pip install (see installation docs)!

    To update:

    1. Fully uninstall the extension first:
    jupyter serverextension disable --py jupyter_notebook_gist
    jupyter nbextension disable --py jupyter_notebook_gist
    jupyter nbextension uninstall --py jupyter_notebook_gist
    pip uninstall jupyter-notebook-gist
    
    1. Follow the instructions above to reinstall

0.4.0 (2016-07-06)

  • Refactored config system to be able to configure it via CLI options or config values in ~/.jupyter/jupyter_notebook_config.py

  • Fixed a bunch of Python packaging and code quality issues

  • Fixed a few issues in Python test suite

  • Set up continuous integration: https://travis-ci.org/mozilla/jupyter-notebook-gist

  • Set up code coverage reports: https://codecov.io/gh/mozilla/jupyter-notebook-gist

  • IMPORTANT Requires manual step to enable after running pip install (see installation docs)!

    To update:

    1. Run pip uninstall jupyter-notebook-gist
    2. Delete gist.js from your nbextensions folder.
    3. Delete any references to jupyter-notebook-gist.create_gist in jupyter_notebook_config.json (in your .jupyter directory)
    4. Delete any references to gist in notebook.json (in .jupyter/nbconfig)
    5. Follow installation instructions to reinstall
You can’t perform that action at this time.