Need help with pgcontents?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

146 Stars 79 Forks Apache License 2.0 233 Commits 10 Opened issues


A Postgres-backed ContentsManager implementation for Jupyter

Services available


Need anything else?

Contributors list


PGContents is a PostgreSQL-backed implementation of

IPEP 27 
_. It aims to a be a transparent, drop-in replacement for IPython's standard filesystem-backed storage system. PGContents'
class can be used to replace all local filesystem storage with database-backed storage, while its
class can be used to replace just IPython's checkpoint storage. These features are useful when running IPython in environments where you either don't have access to—or don't trust the reliability of—the local filesystem of your notebook server.

This repository developed as part of the

Quantopian Research Environment 

Getting Started

Prerequisites: - Write access to an empty

_ database. - A Python installation with
Jupyter Notebook 
_ >= 5.0.


  1. Install
    from PyPI via
    pip install pgcontents
  2. Run
    pgcontents init
    to configure your database. You will be prompted for a database URL for pgcontents to use for storage. (Alternatively, you can set the
    environment variable, or pass
    on the command line).
  3. Configure Jupyter to use pgcontents as its storage backend. This can be done from the command line or by modifying your notebook config file. On a Unix-like system, your notebook config will be located at
    . See the
    directory for example configuration files.
  4. Enjoy your filesystem-free Jupyter experience!

Demo Video

You can see a demo of PGContents in action in

this presentation from JupyterCon 2017

.. _

this presentation from JupyterCon 2017

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.