galou / jupyter-vim

A two-way integration between Vim and Jupyter Kernels.

Jupyter-Vim

A vim plugin for developing code on a Jupyter notebook without leaving the terminal. Currently Python and Julia kernels are supported, and more languages are on the way.

Installation

If you don't have a preferred installation method, I recommend installing pathogen.vim, and then run:

    $ cd ~/.vim/bundle
    $ git clone https://github.com/broesler/jupyter-vim.git

Once help tags have been generated, you can view the manual with :help jupyter-vim.

Quickstart

To begin:

	$ jupyter qtconsole &  # open a jupyter console window
	$ vim <your_script>.py

In vim: :JupyterConnect

Then, use :JupyterRunFile, or :[range]JupyterSendRange to execute lines of code!

Info

Once I fell in love with Vim, I couldn't bear having to jump back and forth between the ipython/jupyter console and editor anymore. I modeled this simple interface off of the ideas in vim-ipython, but have pared down many of the features, like the replication of the Jupyter console in a vim buffer, to make the plugin much more 'lightweight'.

Still a work in progress!

CONTRIBUTING

Please feel free to contact me at [e-mail], with the subject line: "[jupyter-vim]: Contributing".

CREDITS

I owe significant thanks to the original developer of this plugin: Paul Ivanov, as well as Marijn van Vliet. It is far easier to update something that already works well than to forge a new path from scratch.