SwanContents

SwanContents

Server and NB extension that provides:

• SWAN Projects (including readme preview)
• EOS integration (versioning and atomic save)
• git download
• SWAN style in a form of Jupyter Notebook templates

Requirements

Besides Jupyter, this extension requires that the user home is set inside EOS.

Install

Install the package and the nbextension:

pip install swancontents
jupyter nbextension install --user --py swancontents

Do not enable the nbextension, this will be done bellow.

To replace the default Jupyter Contents Manager (including its Javascript library) and the templates, in the Jupyter Notebook configuration (i.e in jupyter_notebook_config.py), set the following:

c.NotebookApp.default_url = 'projects'
c.NotebookApp.contents_manager_class = 'swancontents.filemanager.swanfilemanager.SwanFileManager'
c.ContentsManager.checkpoints_class = 'swancontents.filemanager.checkpoints.EOSCheckpoints'
from swancontents import get_templates
c.NotebookApp.extra_template_paths = [get_templates()]

In case you want to provide a different Galleries website, set the following configuration:

c.NotebookApp.jinja_template_vars = {
    'gallery_url': 'https://swan-gallery.example.com'
}