Jupynium.nvim 安装配置完全指南：从零开始搭建 Python 数据分析环境

【免费下载链接】jupynium.nvimSelenium-automated Jupyter Notebook that is synchronised with Neovim in real-time.项目地址: https://gitcode.com/gh_mirrors/ju/jupynium.nvim

Jupynium.nvim 是一款基于 Selenium 自动化技术的 Neovim 插件，能够实现 Neovim 与 Jupyter Notebook 的实时同步，让你无需离开 Neovim 即可享受 Jupyter Notebook 的交互式数据分析体验。本文将带你从零开始，完成 Jupynium.nvim 的安装与配置，打造高效的 Python 数据分析环境。

📋 准备工作：系统要求与依赖项

在开始安装 Jupynium.nvim 之前，请确保你的系统满足以下要求：

• 操作系统：Linux、macOS 或 Windows（支持 CMD、PowerShell、WSL2）
• Neovim 版本：≥ v0.8
• 浏览器：Firefox（其他浏览器因 Selenium 限制暂不支持）
• Python 环境：≥ 3.9
• Jupyter Notebook：≥ 6.2（Jupyter Lab 暂不支持）
• Mozilla geckodriver：通常随 Firefox 一同安装，可通过geckodriver -V检查

🔧 安装必要的 Python 包

首先需要安装 Jupyter Notebook 及相关组件：

# jupyter-console 为可选组件，用于 :JupyniumKernelOpenInTerminal 命令 pip install notebook nbclassic jupyter-console

注意：Jupynium 暂不支持 Notebook 7，需使用经典界面。设置方法：在配置中修改default_notebook_URL = "localhost:8888/nbclassic"，并确保已安装 nbclassic：pip install --upgrade notebook nbclassic

🐍 Python 环境配置

如果你的系统 Python 版本低于 3.9，或希望使用独立虚拟环境，可以通过以下方式配置：

使用 uv 创建虚拟环境（推荐）

# 下载并安装 Python 3.13（如未安装） uv venv ~/.virtualenvs/jupynium --python=3.13

使用 Conda 创建虚拟环境

conda create -n jupynium python=3

系统 Python 用户

如果使用系统 Python，请确保 pip 版本 ≥ 23.0：

pip3 install --upgrade pip

🚀 Jupynium.nvim 安装步骤

使用 lazy.nvim 安装（推荐）

在你的 Neovim 配置文件中添加以下内容：

{ "kiyoon/jupynium.nvim", build = "pip3 install --user .", -- 虚拟环境用户请使用以下 build 命令 -- build = "uv pip install . --python=$HOME/.virtualenvs/jupynium/bin/python", -- build = "conda run --no-capture-output -n jupynium pip install .", }, "rcarriga/nvim-notify", -- 可选，用于通知功能 "stevearc/dressing.nvim", -- 可选，为 :JupyniumKernelSelect 提供 UI

其他包管理器安装

Plug 'kiyoon/jupynium.nvim', { 'do': 'pip3 install --user .' } " Plug 'kiyoon/jupynium.nvim', { 'do': 'uv pip install . --python=$HOME/.virtualenvs/jupynium/bin/python' } " Plug 'kiyoon/jupynium.nvim', { 'do': 'conda run --no-capture-output -n jupynium pip install .' } Plug 'rcarriga/nvim-notify' " 可选 Plug 'stevearc/dressing.nvim' " 可选，UI for :JupyniumKernelSelect

use { "kiyoon/jupynium.nvim", run = "pip3 install --user ." } -- use { "kiyoon/jupynium.nvim", run = "uv pip install . --python=$HOME/.virtualenvs/jupynium/bin/python" } -- use { "kiyoon/jupynium.nvim", run = "conda run --no-capture-output -n jupynium pip install ." } use { "rcarriga/nvim-notify" } -- 可选 use { "stevearc/dressing.nvim" } -- 可选，UI for :JupyniumKernelSelect

⚙️ 核心配置详解

Jupynium.nvim 的默认配置已能满足大多数用户需求，以下是关键配置项的说明和调整建议：

基础配置模板

在 Neovim 配置文件中添加：

require("jupynium").setup({ -- Conda 用户需修改 python_host -- python_host = { "conda", "run", "--no-capture-output", "-n", "jupynium", "python" }, python_host = vim.g.python3_host_prog or "python3", -- 使用经典 Notebook 界面 default_notebook_URL = "localhost:8888/nbclassic", -- Jupyter 命令（不含 "notebook"） jupyter_command = "jupyter", -- Conda 用户可能需要： -- jupyter_command = { "conda", "run", "--no-capture-output", "-n", "base", "jupyter" }, -- 自动启动服务器设置 auto_start_server = { enable = false, file_pattern = { "*.ju.*" }, }, -- 自动附加到服务器 auto_attach_to_server = { enable = true, file_pattern = { "*.ju.*", "*.md" }, }, -- 自动开始同步 auto_start_sync = { enable = false, file_pattern = { "*.ju.*", "*.md" }, }, -- 自动下载 ipynb 文件 auto_download_ipynb = true, })

关键配置项说明

1. python_host：指定 Python 解释器路径，虚拟环境用户需修改此项
2. default_notebook_URL：Jupyter Notebook 访问地址，默认使用经典界面
3. jupyter_command：启动 Jupyter 的命令，Conda 用户可能需要指定环境
4. 自动同步相关：auto_start_server、auto_attach_to_server和auto_start_sync控制自动化行为，建议新手初期设为false，手动熟悉流程后再开启

语法高亮配置

Jupynium.nvim 提供了自定义高亮组，你可以根据自己的颜色方案进行调整：

-- 默认高亮配置（适用于未知颜色方案） vim.cmd [[ hi! link JupyniumCodeCellSeparator CursorLine hi! link JupyniumMarkdownCellSeparator CursorLine hi! link JupyniumMarkdownCellContent CursorLine hi! link JupyniumMagicCommand Keyword ]]

🔌 集成自动补全（nvim-cmp / blink.cmp）

配置 nvim-cmp

local cmp = require "cmp" local compare = cmp.config.compare cmp.setup { sources = { { name = "jupynium", priority = 1000 }, -- 优先级高于 LSP { name = "nvim_lsp", priority = 100 }, -- 其他补全源... }, sorting = { priority_weight = 1.0, comparators = { compare.score, -- Jupyter 内核补全优先于 LSP compare.recently_used, compare.locality, -- 其他比较器... }, }, }

配置 blink.cmp

require("blink.cmp").setup { sources = { default = { "jupynium", -- 其他补全源... }, providers = { jupynium = { name = "Jupynium", module = "jupynium.blink_cmp", score_offset = 100, -- 优先级高于 LSP }, -- 其他 provider... }, }, }

🎯 快速上手：基本使用流程

1. 创建 Jupynium 文件

新建一个扩展名为.ju.py的文件，例如analysis.ju.py

2. 启动并连接到 Jupynium 服务器

在 Neovim 中执行命令：

:JupyniumStartAndAttachToServer

此命令会自动启动 Jupyter Notebook 并在 Firefox 中打开。如果启动失败，请手动启动 Jupyter：

jupyter notebook

3. 开始同步

在 Neovim 中执行：

:JupyniumStartSync

这会在浏览器中创建一个Untitled.ipynb文件，并开始同步 Neovim 中的内容。

4. 创建和执行代码单元

在 Neovim 中输入# %%创建代码单元：

# %% import numpy as np import pandas as pd # %% data = pd.DataFrame({ 'x': np.random.randn(100), 'y': np.random.randn(100) }) data.head()

使用默认快捷键<space>x执行选中的代码单元。

5. 保存 ipynb 文件

执行以下命令将当前内容保存为 ipynb 文件：

:JupyniumDownloadIpynb

如果启用了auto_download_ipynb = true，系统会自动保存 ipynb 文件。

⌨️ 常用快捷键与命令

核心快捷键

• <space>x: 执行选中的代码单元
• <space>c: 清除选中单元的输出
• <PageUp>,<PageDown>: 滚动 Notebook
• <space>js: 滚动到当前单元（当自动滚动关闭时）
• <space>os: 滚动到输出（当自动滚动关闭时）
• <space>K: 悬停查看变量信息
• <space>jo: 切换输出滚动（当输出过长时）

单元格文本对象

• [j,]j: 跳转到上一个/下一个单元格分隔符
• <space>jj: 跳转到当前单元格分隔符
• vaj,vij,vaJ,viJ: 选择当前单元格（a包含分隔符，i不包含分隔符）

常用 Vim 命令

" 服务器管理 :JupyniumStartAndAttachToServer [notebook_URL] " 启动并附加到服务器 :JupyniumAttachToServer [notebook_URL] " 附加到已有服务器 " 同步控制 :JupyniumStartSync [filename / tab_index] " 开始同步 :JupyniumStopSync " 停止同步 :JupyniumLoadFromIpynbTab tab_index " 从浏览器标签加载内容 " 文件操作 :JupyniumSaveIpynb " 保存 Notebook :JupyniumDownloadIpynb [filename] " 下载 ipynb 文件 " 内核操作 :JupyniumKernelRestart " 重启内核 :JupyniumKernelInterrupt " 中断内核 :JupyniumKernelSelect " 选择内核

📝 Jupynium 文件格式详解

Jupynium 使用 Jupytext 的 percent 格式，文件命名通常为*.ju.py。

代码单元格

使用# %%创建代码单元格：

# %% def add(a, b): return a + b # %% result = add(2, 3) print(result)

魔法命令

以# %开头的行将被识别为 Jupyter 魔法命令：

# %% # %timeit [x**2 for x in range(1000)]

如果需要真正注释魔法命令，请使用## %：

# %% ## %timeit 这行不会被识别为魔法命令

Markdown 单元格

使用# %% [md]或# %% [markdown]创建 Markdown 单元格：

# %% [md] """ # 这是一个 Markdown 标题 这是 Markdown 内容，可以包含： - 列表项 - **粗体**文本 - [链接](https://example.com) """

💡 使用技巧与最佳实践

1. 管理多个 Notebook 文件

可以同时同步多个文件，只需在新文件中再次执行:JupyniumStartSync即可。

2. 处理现有 ipynb 文件

将现有 ipynb 文件转换为 Jupynium 格式：

ipynb2jupytext input.ipynb output.ju.py

或者在连接服务器后，在 Neovim 中执行：

:JupyniumLoadFromIpynbTab tab_index

3. 远程使用 Jupynium

可以通过以下方式连接远程 Neovim：

# 在远程服务器上启动 Neovim nvim --listen localhost:18898 notebook.ju.py # 在本地启动 Jupynium 连接远程 Neovim jupynium --nvim_listen_addr servername.com:18898

4. 折叠单元格

Jupynium 提供了折叠 API，可以与 nvim-ufo 等折叠插件集成：

require("jupynium").get_folds() -- 返回折叠信息

❗ 注意事项

1.** 同步方向：仅支持从 Neovim 到 Jupyter Notebook 的单向同步，不要在浏览器中直接修改内容 2.主页面：保持 Jupyter Notebook 主页面（文件浏览器）可访问，Jupynium 需要通过它打开文件 3.保存习惯**：定期执行:JupyniumDownloadIpynb保存 ipynb 文件，以防意外丢失 4.** 版本兼容性**：确保使用兼容版本的 Jupyter Notebook（6.x），暂不支持 Notebook 7

🚧 常见问题解决

Firefox 无法启动

确保 Selenium 环境配置正确，可通过以下代码测试：

from selenium import webdriver driver = webdriver.Firefox() driver.get("https://www.selenium.dev/selenium/web/web-form.html")

Ubuntu 22.04+ 用户注意：需要使用 apt 安装 Firefox（非 snap 版本），或确保 geckodriver 在$PATH中。

内容不同步

如果 Neovim 与 Notebook 内容不同步，可能是因为直接在浏览器中修改了内容：

• 若要保留 Neovim 内容：在 Notebook 中添加一个新单元格，然后在 Neovim 中继续编辑
• 若要加载 Notebook 内容：在 Neovim 中执行:JupyniumLoadFromIpynbTab [tab_index]

支持其他编程语言

除了 Python，Jupynium 也支持其他 Jupyter 内核（如 R），只需创建相应扩展名的文件，如analysis.ju.r。

🎉 总结

通过本文的指南，你已经掌握了 Jupynium.nvim 的安装配置和基本使用方法。Jupynium.nvim 为 Neovim 用户提供了无缝的 Jupyter Notebook 体验，让你能够在熟悉的编辑器环境中进行交互式数据分析。

随着使用的深入，你可以进一步探索 Jupynium.nvim 的高级功能，如自定义快捷键、集成代码折叠、扩展 Lua API 等，打造属于自己的高效数据分析工作流。

祝你使用愉快，数据分析效率倍增！

【免费下载链接】jupynium.nvimSelenium-automated Jupyter Notebook that is synchronised with Neovim in real-time.项目地址: https://gitcode.com/gh_mirrors/ju/jupynium.nvim