跳转到主要内容

显示课程级别和结构的Jlab扩展

项目描述

jupyterlab_courselevels

Github Actions Status

JupyterLab扩展,用于

  • 根据预期受众级别以颜色显示单元格;颜色代码遵循滑雪道逻辑

    • 绿色:基本 - 所有学生都应该知道
    • 蓝色:中级 - 如果你想要更深入挖掘
    • 红色:高级 - 为极客
  • 此外,一些单元格可能显示带有周围框架的框架,以强调课程结构

重要限制

由于MyST Markdown的渲染方式,颜色和框架在Jupyter Lab中正确渲染,但在jupyter-book输出的代码单元格中不会正确渲染

因此,颜色和框架在markdown单元格上不再相关,我们使用警示代替

需求

  • JupyterLab >= 4.0.0

安装

要安装扩展,请执行

pip install jupyterlab_courselevels

卸载

要删除扩展,请执行

pip uninstall jupyterlab_courselevels

其他命令

命令 快捷键 注释
courselevels:toggle-basic Ctrl-\ Ctrl-X
courselevels:toggle-intermediate Ctrl-\ Ctrl-Y
courselevels:toggle-advanced Ctrl-\ Ctrl-Z
courselevels:toggle-frame Ctrl-\ Ctrl-M
courselevels:toggle-licence Ctrl-\ Ctrl-L
courselevels:metadata-clean-selected Alt-Cmd-7 清理所选单元格的元数据
courselevels:metadata-clean-all Ctrl-Alt-7 清理所有单元格的元数据

持久性

这是通过在每一行添加以下标签来实现的

  • 基础级别
  • 中级级别
  • 高级级别
  • 框架单元格

渲染

我们依赖于jupyterlab-celltagsclasses扩展,它将设置如cell-tag-level_basic之类的类

设置

默认情况下,不显示按钮;您可以将show_level_buttons布尔设置设置为true以在工具栏中显示按钮

开发

开发安装

注意:您将需要NodeJS来构建扩展包。

jlpm命令是JupyterLab附带的yarn的固定版本,该版本随JupyterLab一起安装。您可以使用下面的yarnnpm代替jlpm

# Clone the repo to your local environment
# Change directory to the jupyterlab_courselevels directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build

您可以在不同的终端中同时监视源目录并运行JupyterLab,以监视扩展源中的更改并自动重新构建扩展。

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

在监视命令运行时,每次保存的更改都将立即在本地上构建并可在您的运行的JupyterLab中使用。刷新JupyterLab以在浏览器中加载更改(您可能需要等待几秒钟以重新构建扩展)。

默认情况下,jlpm build命令为此扩展生成源映射,以便更容易使用浏览器开发工具进行调试。要同时为JupyterLab核心扩展生成源映射,您可以运行以下命令

jupyter lab build --minimize=False

开发卸载

pip uninstall jupyterlab_courselevels

在开发模式下,您还需要删除由jupyter labextension develop命令创建的符号链接。要找到其位置,您可以运行jupyter labextension list以确定labextensions文件夹的位置。然后您可以在该文件夹中删除名为jupyterlab-courselevels的符号链接。

打包扩展

请参阅RELEASE

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分发

jupyterlab_courselevels-0.8.1.tar.gz (194.3 kB 查看散列)

上传时间

构建分发

jupyterlab_courselevels-0.8.1-py3-none-any.whl (93.7 kB 查看散列)

上传时间 Python 3

由以下支持