dfkernel 的安装和配置教程

项目基础介绍

dfkernel 是一个开源项目，它允许用户在 JupyterLab 中创建和运行具有清晰依赖关系的 Python 笔记本。这种笔记本被称为数据流笔记本，它通过将输出提升为链接单元格来工作。单元格的输出通过标识符进行标记，当其他单元格引用这些输出时，会在单元格之间创建依赖关系，确保在执行一个单元格之前，其上游单元格是最新的。

项目主要编程语言

该项目主要使用 TypeScript 和 Python 编程语言。

项目使用的关键技术和框架

• JupyterLab: 一个基于网页的交互式计算环境，允许用户组合代码、可视化和文本。
• IPython: 一个强大的交互式 shell，用于执行 Python 代码。
• ipykernel: Jupyter 内核，用于支持 Python 代码的执行。
• Playwright (用于测试): 一个 Node.js 库，用于自动化 Chromium、Firefox 和 WebKit 浏览器。

项目安装和配置的准备工作

在开始安装 dfkernel 之前，请确保您的系统已安装以下依赖项：

• Python: 版本至少为 3.7。
• NodeJS: 用于构建前端部分。
• JupyterLab: 版本至少为 4.0.0。

确保您的系统中已安装了 pip 和 npm，它们是安装 Python 包和 Node.js 包的工具。

安装步骤

以下是安装 dfkernel 的详细步骤：

1. 安装 dfnotebook

   打开命令行界面，执行以下命令来安装 dfnotebook 扩展：

   pip install dfnotebook
   

2. 启动 JupyterLab

   接下来，启动 JupyterLab：

   jupyter lab
   

3. 创建新笔记本

   在 JupyterLab 中，创建一个新的笔记本，并选择 DFPython 3 内核。

4. 开发模式下的安装 (可选)

   如果您打算在开发模式下安装 dfnotebook，以便进行自定义或贡献代码，请按照以下步骤操作：

   • 克隆存储库到本地环境：

     git clone https://github.com/dataflownb/dfnotebook.git
     cd dfnotebook
     

   • 在开发模式下安装包：

     pip install -e .
     

   • 将开发版本的扩展与 JupyterLab 链接：

     jupyter labextension develop . --overwrite
     

   • 在更改后重建扩展 TypeScript 源：

     jlpm build
     

   • 监视源目录并自动重建：

     jlpm watch
     

5. 卸载 dfnotebook

   如果需要卸载 dfnotebook，可以使用以下命令：

   pip uninstall dfnotebook
   

   在开发模式下，还需要移除通过 jupyter labextension develop 命令创建的符号链接。

确保在每次安装或更新操作后重新启动 JupyterLab，以使更改生效。

以上就是 dfkernel 的安装和配置教程，按照这些步骤操作，您应该能够成功安装并开始使用 dfkernel。