https://github.com/ktaletsk/jupyterlab_command_test
Sample extension showing how to add command to JupyterLab menus
https://github.com/ktaletsk/jupyterlab_command_test
example jupyterlab jupyterlab-extension tutorial
Last synced: 7 months ago
JSON representation
Sample extension showing how to add command to JupyterLab menus
- Host: GitHub
- URL: https://github.com/ktaletsk/jupyterlab_command_test
- Owner: ktaletsk
- Created: 2019-09-26T13:19:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T02:06:47.000Z (over 1 year ago)
- Last Synced: 2024-12-31T14:58:09.639Z (about 1 year ago)
- Topics: example, jupyterlab, jupyterlab-extension, tutorial
- Language: TypeScript
- Homepage:
- Size: 274 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# command_test
Sample extension demonstrating how to register new command and add it to command pallete, main menu and context menu
## Requirements
* JupyterLab >= 0.30.0
## Install
```bash
jupyter labextension install command_test
```
### Install
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Clone the repo to your local environment
# Move to command_test directory
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build
```
You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.
```bash
# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch
```
### Uninstall
```bash
jupyter labextension uninstall command_test
```