Skip to content

wusung/ipython-notebook-store

Repository files navigation

Bookstore

https://badge.fury.io/py/bookstore.png https://travis-ci.org/rgbkrk/bookstore.png?branch=master

Add multiple checkpoints for IPython.

Add your provider with a pull request!

Note: Bookstore requires IPython 1.0+

Bookstore currently has generic support for OpenStack Swift and simplified authentication for Rackspace's CloudFiles. Bookstore also handles IPython notebook's autosave/checkpoint feature and as of the latest release supports multiple checkpoints:

Multiple checkpoints

Once installed and configured (added to an ipython profile), just launch IPython notebook like normal:

$ ipython notebook
2013-08-01 13:44:19.199 [NotebookApp] Using existing profile dir: u'/home/user/.ipython/profile_default'
2013-08-01 13:44:25.384 [NotebookApp] Using MathJax from CDN: http://cdn.mathjax.org/mathjax/latest/MathJax.js
2013-08-01 13:44:25.400 [NotebookApp] Serving rgbkrk's notebooks on Rackspace CloudFiles from container: notebooks
2013-08-01 13:44:25.400 [NotebookApp] The IPython Notebook is running at: http://127.0.0.1:9999/
2013-08-01 13:44:25.400 [NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).

Installation

Simply:

$ pip install bookstore

Alternatively, you can always pull from the master branch if you're the adventurous type:

$ pip install git+https://wusung@bitbucket.org/wusung/ipython-bookstore.git
$ pip install --upgrade git+https://github.com/wusung/ipython-notebook-store.git

Installation isn't the end though. You need to configure your account details as well as where you'll be storing the notebooks.

Configuration

Bookstore has to be added to an IPython profile and configured to work with your OpenStack provider.

If you want to keep it simple, just add your configuration to the default configuration located at:

~/.ipython/profile_default/ipython_notebook_config.py

Alternatively, you can create a brand new notebook profile for bookstore:

$ ipython profile create swiftstore
[ProfileCreate] Generating default config file: u'/Users/theuser/.ipython/profile_swiftstore/ipython_config.py'
[ProfileCreate] Generating default config file: u'/Users/theuser/.ipython/profile_swiftstore/ipython_notebook_config.py'

When launching, just set the custom profile you want to use

$ ipython notebook --profile=swiftstore

Each provider has their own setup for authentication.

Using Multiple Files Manager

OpenStack (generic, non provider specific) has quite a few details you'll need to configure, namely account name, account key, auth endpoint, and region. You'll possibly need a tenant id and a tenant name.

Add this to your ipython notebook profile ipython_notebook_config.py, making sure it comes after the config declaration c = get_config().

c = get_config()

# Setup IPython Notebook to support multiple checkpoints
c.NotebookApp.notebook_manager_class = 'bookstore.filenotebookmanager.FileNotebookManager'

Contributing

Send a pull request on GitHub. It's that simple. More than happy to respond to issues on GitHub as well.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages