📊 DataNvim

DataNvim is a custom Neovim distribution prepared for Data Science and to easily run code and interact with Jupyter Notebooks without ever leaving your terminal. It also provides a well structured config that makes it an easy starting point to extend it as you want.

DataNvim

📋 Requirements

GCC
Kitty 0.28+
Neovim 0.9.4+
Python 3.10+
Ripgrep 11.0+
Quarto
Npm 10.8.1+
ImageMagick
Lua 5.1
Required python packages:
- pynvim
- jupyter_client
- cairosvg
- plotly and kaleido
- pyperclip
- nbformat
- pillow
- ipykernel

✨ Feature Highlights

Carefully designed configuration file structure for easy extension and modification
Beautiful colorscheme from catppuccin
Powerful file explorer with nvim-tree
Fuzzy search and preview files, words and gitfiles thanks to telescope
Preconfigured highlighting and Lsp Autocompletion for Python thanks to treesitter and nvim-lsp-config
Extensible formatting, diagnostics, code actions and completion with none-ls and ruff
Complete Jupyter Notebook interaction set up thanks to molten.nvim, quarto, and jupytext
Simple but beautiful status bar thanks to lualine.nvim
Easy buffer navigation with bufferline.nvim

🔍 Want to try our Docker Container first?

Pull DataNvim's image from ghcr.io/noopeeks/data-nvim:latest

docker run -it ghcr.io/noopeeks/data-nvim:latest /bin/bash
# Once inside prompt, run nvim
nvim

Try it out, there is a demo .ipynb file in the home directory!

🛠️ Setting up for the first time

[!WARNING] DataNvim will only render images if the terminal it's used on is Kitty!

Install all the listed dependencies
Install Kitty
Install luarocks, Lua language's package manager.
Install the magick rock with: luarocks --local --lua-version=5.1 install magick
Create a virtual environment for Neovim in ~/.virtualenvs/

mkdir ~/.virtualenvs
cd ~/.virtualenvs
python -m venv neovim

Activate the virtual environment and install the beforementioned python packages with:

source ~/.virtualenvs/neovim/bin/activate
pip install ipykernel jupytext pynvim jupyter_client cairosvg plotly kaleido pyperclip nbformat pillow
python -m ipykernel
deactivate

Install ipykernel and jupytext in your project-scoped virtual environment

cd whatever/directory/your/project/is/in
source venv/bin/activate
pip install ipykernel jupytext
python -m ipykernel install --user --name project_name

Backup your current Neovim configuration

mv ~/.config/nvim ~/config/nvim.bak

Install DataNvim's configuration

git clone https://github.com/NoOPeEKS/DataNvim.git ~/.config/nvim && nvim

Run the following commands:

:UpdateRemotePlugins
:MasonInstallAll

Open your notebook with the virtual environment activated and load the kernel with :MoltenInit project_name or <kbd>Space</kbd> + <kbd>m</kbd> + <kbd>i</kbd>.
Start executing cells with Keybindings

⌨️ Keybindings

Vim actions

| Key | Mode | Action | | ---------------------------------------------------------------------------------------- | :--: | ----------------------------------- | | <kbd>Ctrl</kbd> + <kbd>h</kbd> | i | Navigate left in insert mode | | <kbd>Ctrl</kbd> + <kbd>j</kbd> | i | Navigate down in insert mode | | <kbd>Ctrl</kbd> + <kbd>k</kbd> | i | Navigate up in insert mode | | <kbd>Ctrl</kbd> + <kbd>l</kbd> | i | Navigate right in insert mode | | <kbd>Ctrl</kbd> + <kbd>s</kbd> |i, v, n| Save current buffer | | <kbd>Space</kbd> + <kbd>x</kbd> | n | Close current buffer | | <kbd>Tab</kbd> | n | Go to next buffer | | <kbd>Shift</kbd> + <kbd>Tab</kbd> | n | Go to previous buffer |

Plugins

NvimTree

None-ls

Molten.nvim

| Key | Mode | Action | | ---------------------------------------------------------------------------------------- | :--: | ----------------------------------- | | <kbd>Space</kbd> + <kbd>m</kbd> + <kbd>i</kbd> | n | Molten Init Python Kernel | | <kbd>Space</kbd> + <kbd>m</kbd> + <kbd>l</kbd> | n | Molten Evaluate Current Line | | <kbd>Space</kbd> + <kbd>m</kbd> + <kbd>v</kbd> | v | Molten Evaluate Visual Selection | | <kbd>Space</kbd> + <kbd>m</kbd> + <kbd>o</kbd> | n | Molten Enter Cell Output | | <kbd>Space</kbd> + <kbd>m</kbd> + <kbd>h</kbd> | n | Molten Hide Output |

Telescope

| Key | Mode | Action | | ---------------------------------------------------------------------------------------- | :--: | ----------------------------------- | | <kbd>Space</kbd> + <kbd>f</kbd> + <kbd>f</kbd> | n | Telescope Fuzzy Find File | | <kbd>Space</kbd> + <kbd>f</kbd> + <kbd>w</kbd> | n | Telescope Fuzzy Find Word | | <kbd>Space</kbd> + <kbd>f</kbd> + <kbd>b</kbd> | n | Telescope Fuzzy Find Buffers | | <kbd>Space</kbd> + <kbd>f</kbd> + <kbd>o</kbd> | n | Telescope Fuzzy Find Oldfiles | | <kbd>Space</kbd> + <kbd>f</kbd> + <kbd>z</kbd> | n | Telescope Fuzzy Find Current Buffer | | <kbd>Space</kbd> + <kbd>f</kbd> + <kbd>h</kbd> | n | Telescope Help Tags |

LSP

| Key | Mode | Action | |-------------------------------------------------------| :--: |-----------------------------------------| | <kbd>g</kbd> + <kbd>D</kbd> | n | Go to Declaration | | <kbd>g</kbd> + <kbd>d</kbd> | n | Go to Definition | | <kbd>K</kbd> | n | Hover | | <kbd>g</kbd> + <kbd>i</kbd> | n | Go to Implementation | | <kbd>leader</kbd> + <kbd>c</kbd> + <kbd>a</kbd> | n | Code Action | | <kbd>Ctrl</kbd> + <kbd>k</kbd> | n | Signature Help | | <kbd>Space</kbd> + <kbd>w</kbd> + <kbd>a</kbd> | n | Add Workspace Folder | | <kbd>Space</kbd> + <kbd>w</kbd> + <kbd>r</kbd> | n | Remove Workspace Folder | | <kbd>Space</kbd> + <kbd>w</kbd> + <kbd>l</kbd> | n | List Workspace Folders | | <kbd>Space</kbd> + <kbd>D</kbd> | n | Go to Type Definition | | <kbd>Space</kbd> + <kbd>r</kbd> + <kbd>n</kbd> | n | Rename | | <kbd>g</kbd> + <kbd>r</