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)
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:
Run pip uninstall jupyter-notebook-gist
Delete gist.js from your nbextensions folder.
Delete any references to jupyter-notebook-gist.create_gist in jupyter_notebook_config.json (in your .jupyter directory)
Delete any references to gist in notebook.json (in .jupyter/nbconfig)
Follow installation instructions to reinstall
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
Built Distribution
Hashes for jupyter-notebook-gist-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 598541e1c59f109565900fb701ed760b3d83e185290ad8896e8d105cd3af6bc3 |
|
MD5 | 135154a94bc72e44ddc5ca3c390d8e06 |
|
BLAKE2b-256 | bfdc3296bca66627b57fd11bb6420464ebb7e027478f6bc5b889df2a30c5a94f |
Hashes for jupyter_notebook_gist-0.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ed086c1a1654dd80878a3a2b33bb4c72a93ba47bb4d8ee3da5f26382a63c866 |
|
MD5 | 07fbf4ed0cab450de7c57190ba5328b3 |
|
BLAKE2b-256 | 2569d7627ea2276860c8f535f3ebd7901d73b367a83801289e94b6f63c092004 |