Skip to main content

Save the history of your IPython notebooks with git

Project description

# ipylogue - IPython notebook storage backed by git

Like tracking checkpoints in your ipython notebooks? Perhaps you’d like better control over their revisions. Then ipylogue is for you. Heavy duty VCS for your ipython notebooks.

For another way to share notebooks, check out [bookstore][bookstore] ([Rackspace’s post about it][blogpost]), which lets you publish notebooks to OpenStack Swift (or Rackspace Cloud Files) automatically.

[bookstore]: https://github.com/rgbkrk/bookstore [blogpost]: https://developer.rackspace.com/blog/bookstore-for-ipython-notebooks/

# Usage

Note: Requires IPython 1.0.0+

Add this to your ipython notebook profile (ipython_notebook_config.py):

` # c.NotebookApp.notebook_manager_class = 'IPython.html.services.notebooks.filenbmanager.FileNotebookManager' c.NotebookApp.notebook_manager_class = 'ipylogue.gitmanager.GitNotebookManager' c.GitNotebookManager.commiter_name = u'COMMITTER_NAME' c.GitNotebookManager.commiter_email = u'COMMITTER_EMAIL' `

It’s easy to set up a notebook profile if you don’t have one:

` $ ipython profile create ipylogue [ProfileCreate] Generating default config file: u'/home/yourname/.ipython/profile_ipylogue/ipython_config.py' [ProfileCreate] Generating default config file: u'/home/yourname/.ipython/profile_ipylogue/ipython_notebook_config.py' [ProfileCreate] Generating default config file: u'/home/yourname/.ipython/profile_ipylogue/ipython_nbconvert_config.py' `

You can also use your default config, located at ~/.ipython/profile_default/ipython_notebook_config.py

# TODO

Add the option to have the root of your notebook folder be a subdir of your repository ` c.GitNotebookManager.repo_subdir = u'notebooks' # OPTIONAL: a directory *inside* the repo where you want notebooks to put notebooks `

# Licensing

Affero GPLv3, see COPYING.txt for full license

Also see https://github.com/FriendCode/gittle for dulwich usage examples

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
ipylogue-1.0.1.tar.gz (34.2 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page