My custom tweaks for using JLAB
Project description
jupyterlab_tpt
My custom tweaks for using JLAB; something that would have gone into a custom.js
in nb classic...
Requirements
- JupyterLab >= 4.0.0
- jupyterlab-myst
Install
To install the extension, execute:
pip install jupyterlab_tpt
Uninstall
To remove the extension, execute:
pip uninstall jupyterlab_tpt
misc commands and keystrokes
search for convenience
in the command palette to see the list of commands and associated keystrokes
as well as for adding/removing an admonition around a cell
command | keybinding |
---|---|
admonition:toggle |
Ctrl-\ Ctrl-A |
admonition:toggle-tip |
Ctrl-\ Ctrl-T |
admonition:toggle-note |
Ctrl-\ Ctrl-N |
admonition:toggle-attention |
|
admonition:toggle-caution |
|
admonition:toggle-danger |
|
admonition:toggle-error |
|
admonition:toggle-hint |
|
admonition:toggle-important |
|
admonition:toggle-seealso |
|
admonition:toggle-warning |
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_tpt 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_tpt
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-tpt
within that folder.
Packaging the extension
See RELEASE
My notes
-
on using signals https://github.com/jupyterlab/extension-examples/tree/master/signals
-
a very useful example of arming callbacks on changes https://discourse.jupyter.org/t/how-to-get-output-model-for-a-given-cell-in-a-jupyterlab-extension/11342/6
-
waiting for a notebook context to be ready
notebookContext: DocumentRegistry.IContext<INotebookModel> notebookContext.ready.then(() => { /* * The order of operations here is key. First, create a model that contains a log of * executed cells and the state of the gather UI. */ let notebookModel = notebookContext.model; ... })
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
Hashes for jupyterlab_tpt-0.8.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85bdf956a428f32daf8c75a2552f6764ae21cfa48d4b58e7b7f193e77efc9512 |
|
MD5 | f3ddee1781d322cf7c0ab3929b61df90 |
|
BLAKE2b-256 | 97933b782532051901403e979b6ef024b23918c43357a9088596ae07590937cc |