jupyter_ascending

Sync Jupyter Notebooks from any editor

Installation

$ pip install jupyter_ascending
$ # It is possible you won't need to run the following commands on newer version of jupyter notebook,
$ # but it's recommended that you do anyway, because installing extensions is hard.
$ jupyter nbextension install --py --sys-prefix jupyter_ascending
$ jupyter nbextension     enable jupyter_ascending --sys-prefix --py
$ jupyter serverextension enable jupyter_ascending --sys-prefix --py

You can confirm it's installed by checking:

$ jupyter nbextension     list
$ jupyter serverextension list

About

Jupyter Ascending syncs the state between a python script and a Jupyter notebook.

At the moment, it syncs between python scripts that end with .sync.py and Jupyter notebooks with names that end with .sync.ipynb.

To get a properly formatted .sync.py file, you should use jupytext to generate one. You can convert it to a Jupyter notebook with jupytext as well!

Getting started

Jupyter ascending provides some scripts to help users. To get a pair of synced py and ipynb files, you could run the following:

$ python -m jupyter_ascending.scripts.make_pair --base examples/test

Which will create a pair of files: examples/test.sync.py and examples/test.sync.ipynb. You can read the help for the command to find more information.

Usage in Vim

To use in vim, see: jupyter_ascending.vim

Local development

To do local development:

# install dependencies
$ poetry install

# Installs the extension, using symlinks
$ jupyter nbextension install --py --sys-prefix --symlink jupyter_ascending

# Enables them, so it auto loads
$ jupyter nbextension enable jupyter_ascending --py --sys-prefix
$ jupyter serverextension enable jupyter_ascending --sys-prefix --py

To check that they are enabled, do something like this: