Jlab extension for showing course levels and structure
Project description
jupyterlab_courselevels
JupyterLab extension to
-
display cells in colors based on their intended audience level; the color codes follows the logic of ski tracks
- green : basic - all students should know that
- blue : intermediate - if you want to dig a little more
- red : advanced - for the geeks
-
in addition some cells may show up with a surrounding frame, to emphasize the course structure
Important limitation
because of the way MyST markdown is rendered, colors and frames are correctly rendered within Jupyter Lab, but they will not render properly on code cells in the jupyter-book output
For this reason, colors and frames are no longer relevant on markdown cells, and we use admonition instead
Requirements
- JupyterLab >= 4.0.0
Install
To install the extension, execute:
pip install jupyterlab_courselevels
Uninstall
To remove the extension, execute:
pip uninstall jupyterlab_courselevels
misc commands
command | keybinding | comment |
---|---|---|
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 |
clean metadata on selected cells |
courselevels:metadata-clean-all |
Ctrl-Alt-7 |
clean metadata on all cells |
persistence
this is done by adding the following tags in each cell
level_basic
level_intermediate
level_advanced
framed_cell
rendering
we rely on the jupyterlab-celltagsclasses
extension, which will set classes
like e.g. cell-tag-level_basic
settings
by default, no button is displayed; you can set the show_level_buttons
boolean
setting to true
to get the buttons to display in the toolbar
Development
Development install
Note: You will need NodeJS to build the extension package.
The jlpm
command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
yarn
or npm
in lieu of jlpm
below.
# 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
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the jlpm build
command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
jupyter lab build --minimize=False
Development uninstall
pip uninstall jupyterlab_courselevels
In development mode, you will also need to remove the symlink created by jupyter labextension develop
command. To find its location, you can run jupyter labextension list
to figure out where the labextensions
folder is located. Then you can remove the symlink named jupyterlab-courselevels
within that folder.
Packaging the extension
See RELEASE
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file jupyterlab_courselevels-0.8.1.tar.gz
.
File metadata
- Download URL: jupyterlab_courselevels-0.8.1.tar.gz
- Upload date:
- Size: 194.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2798dabf5c3d5e99ae867cdf766b513e01f18e78327000d289145f756e3ff4b0 |
|
MD5 | c3f08ba4dbb4f5ec0290c95ab118c592 |
|
BLAKE2b-256 | 9485f21678fd1f7b379087f95aed173bcfdc155b9d75c0e333aa8989d209ea1b |
File details
Details for the file jupyterlab_courselevels-0.8.1-py3-none-any.whl
.
File metadata
- Download URL: jupyterlab_courselevels-0.8.1-py3-none-any.whl
- Upload date:
- Size: 93.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4063912764232c59686668ec93b3577d772dc468ba7d3a00e1d33e662e1f2fd7 |
|
MD5 | 4dd8129cb54fb71528ac5f0b56aaa7fc |
|
BLAKE2b-256 | bb66876b4647840ceda220b5788d5dbfbdafe3dc08af128e9669072463c620e8 |