Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Create a gist from the Jupyter Notebook UI

Project Description
### jupyter-notebook-gist

[![Build Status](https://travis-ci.org/mozilla/jupyter-notebook-gist.svg?branch=master)](https://travis-ci.org/mozilla/jupyter-notebook-gist)

[![codecov](https://codecov.io/gh/mozilla/jupyter-notebook-gist/branch/master/graph/badge.svg)](https://codecov.io/gh/mozilla/jupyter-notebook-gist)

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

```python
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](https://github.com/settings/applications).

Here's an [example of an OAuth application](https://cloud.githubusercontent.com/assets/969479/14916551/add90efc-0df0-11e6-8cfb-277754a48b66.png)
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

### 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
Release History

Release History

This version
History Node

0.4.0

History Node

0.3.1

History Node

0.3.0

History Node

0.2.1

History Node

0.1.1

History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
jupyter_notebook_gist-0.4.0-py2.py3-none-any.whl (10.7 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Jul 7, 2016
jupyter-notebook-gist-0.4.0.tar.gz (12.3 kB) Copy SHA256 Checksum SHA256 Source Jul 7, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting