SWAN Contents Manager for Jupyter
Project description
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'
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
swancontents-1.3.2.tar.gz
(73.8 kB
view hashes)
Built Distribution
Close
Hashes for swancontents-1.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f9f652d55f7c356c6745f7751b95b2b2d1c131181ecf01402a8dd118dcf5bb5 |
|
MD5 | 185e95f6f9b5f587d6046ba043f32d7d |
|
BLAKE2b-256 | a6f062052b6b830ac3a282ac94366f6a1ec3647f36bca6a1cc790fabe3679342 |