Skip to content
Vim plugin for editing Jupyter ipynb files via jupytext
Vim script
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
plugin
HISTORY.md
LICENSE
README.md

README.md

jupytext.vim

Vim/Neovim plugin for editing Jupyter notebook (ipynb) files through jupytext.

https://www.vim.org/scripts/script.php?script_id=5764

Installation

  1. Make sure that you have the jupytext CLI program installed (pip install jupytext).
  2. Copy the jupytext.vim script to your vim plugin directory (e.g. $HOME/.vim/plugin). Refer to :help add-plugin, :help add-global-plugin and :help runtimepath for more details about Vim plugins.
  3. Restart Vim.

Usage

When you open a Jupyter Notebook (*.ipynb) file, it is automatically converted from json to markdown or python through the jupytext utility, and the result is loaded into the buffer. Upon saving, the ipynb file is updated with any modifications.

In more detail, opening a file notebook.ipynb in vim will create a temporary file notebook.md or notebook.py (depending on g:jupytext_fmt). This file is the result of calling e.g.

jupytext --to=md --output notebook.md notebook.ipynb

jupytext.vim screenshot

The contents of the file is loaded into the buffer instead of the original notebook.ipynb. When saving the buffer, its contents is written again to notebook.md, and the original notebook.ipynb is updated with a call to

jupytext --to=ipynb --from=md --update --output notebook.ipynb notebook.md

The --update flag ensures the output for any cell whose corresponding input in notebook.md is unchanged will be preserved.

On closing the buffer, the temporary notebook.md will be deleted. If notebook.md already existed when opening notebook.ipynb, the existing file will be used (instead of being generated by jupytext), and it will be preserved when closing the buffer.

Configuration

The plugin has the following settings. If you want to override the default values shown below, you can define the corresponding variables in your ~/.vimrc.

  • let g:jupytext_enable = 1

    You may disable the automatic conversion of ipynb files (i.e., deactivate this plugin) by setting this to 0.

  • let g:jupytext_command = 'jupytext'

    The CLI jupytext command to use. You may include the full path to point to a specific jupytext executable not in your default $PATH.

  • let g:jupytext_fmt = 'md'

    The format to which to convert the ipynb data. This can be any format that the jupytext utility accepts for its --to parameter (see jupytext --help), except for 'notebook' and 'ipynb'.

  • let g:jupytext_to_ipynb_opts = '--to=ipynb --update'

    Command line options for the conversion from g:jupytext_fmt back to the notebook format

  • let g:jupytext_filetype_map = {}

    A mapping of g:jupytext_fmt to the filetype that should be used for the buffer (:help filetype). This determines the syntax highlighting. You may use this setting to override the default filetype. For example, to use the 'pandoc' filetype instead of the default 'markdown' for the 'md' format, define

    let g:jupytext_filetype_map = {'md': 'pandoc'}
    
  • let g:jupytext_print_debug_msgs = 0

    If set to 1, print debug messages while running the plugin (view with :messages).

Note: If you are using this plugin as a replacement for the ipynb_notedown.vim plugin (https://www.vim.org/scripts/script.php?script_id=5506), you can use the following options to use notedown instead of jupytext:

let g:jupytext_command = 'notedown'
let g:jupytext_fmt = 'markdown'
let g:jupytext_to_ipynb_opts = '--to=notebook'
You can’t perform that action at this time.