jupynium.nvim
A Neovim plugin that provides real-time, bidirectional synchronization with Jupyter Notebook using Selenium automation.
What is jupynium.nvim?
Jupynium is a Neovim plugin that synchronizes your editing session with a Jupyter Notebook in real-time using Selenium automation. It allows developers to write and execute code cells entirely within Neovim while seeing live results in a browser, eliminating the need to switch between editor and notebook interfaces. The plugin supports any Jupyter kernel and works with remote notebooks, making it ideal for interactive computing workflows.
Data scientists, researchers, and developers who use Jupyter Notebooks for interactive computing but prefer editing in Neovim. It's especially useful for those working with remote notebooks or multiple kernels (e.g., Python, R).
Jupynium offers a unique, keyboard-driven workflow that integrates Jupyter Notebook directly into Neovim without requiring kernel extensions. Its real-time sync, support for remote notebooks, and compatibility with any kernel provide flexibility unmatched by other editor-notebook integrations.
Overview
Selenium-automated Jupyter Notebook that is synchronised with Neovim in real-time.
Use Cases
Best For
- Editing Jupyter Notebooks entirely within Neovim for a keyboard-centric workflow
- Working with remote Jupyter servers (e.g., university-hosted or cloud notebooks)
- Using alternative kernels like R or Julia without leaving your editor
- Maintaining notebook code in version control using Jupytext's percent format
- Data scientists who prefer Neovim's editing capabilities over web-based notebooks
- Developing interactive reports or tutorials with live previews
Not Ideal For
- Users who rely on Jupyter Lab's modern interface and features
- Teams requiring bidirectional sync to edit directly in the browser without restrictions
- Environments where Firefox is not available or browser automation is blocked
- Projects using the latest Jupyter Notebook version 7, as it's not yet supported
Pros & Cons
Pros
Automatically mirrors every keystroke from Neovim to Jupyter Notebook, providing a live preview without manual refresh, as demonstrated in the README's GIF.
Works with any Jupyter kernel, including Python, R, and Julia, without requiring kernel-specific extensions, making it versatile for multi-language projects.
Allows editing notebooks locally while executing code on remote servers, ideal for cloud-based or institutional environments, as highlighted in the remote development feature.
Integrates cell management, execution, and navigation into Neovim's command and keybinding system, minimizing mouse usage and catering to power users.
Uses Jupytext's text-based percent format (.ju.py) which is easier to diff and merge in Git than JSON-based .ipynb files, enhancing collaboration.
Cons
Changes made in the browser notebook are not reflected back in Neovim, requiring strict discipline to edit only in the editor, as noted in the README's caution section.
Relies exclusively on Firefox for Selenium automation, excluding users who prefer Chrome or other browsers, due to limitations documented in issue #49.
Does not support Jupyter Lab, limiting users to the older Jupyter Notebook interface, which may lack modern features and extensions.
Requires installing Neovim v0.8+, Firefox, geckodriver, Python 3.9+, and Jupyter Notebook 6, with potential compatibility issues and manual configuration steps.
Frequently Asked Questions
Related Projects
strudel.nvimA Neovim based strudel.cc controller, live coding using Strudel from Neovim.
live-preview.nvimA Live Preview Plugin for Neovim that allows you to view Markdown, HTML (along with CSS, JavaScript), AsciiDoc, SVG files in a web browser with live updates.
neopyterThe bridge between Neovim and Jupyterlab
prelive.nvimA simple luv-based development server with live reloading for Neovim.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.