No project description provided
Project description
Jupyter React Widget Template
This is a basic repository setup for a React-based jupyter widget, based on the tools I like to use at the moment. There's a lot required to get this all working and there aren't a lot of good references out there, so I made this repo as a reference for myself that I can copy when creating new Jupyter widget packages.
(See the lmk README for more info, all of this info originated from there)
Set up
-
Create virtual environment:
python -m venv venv
-
Install dependencies with
pnpm install
-
Install the package with `pip install -e '.[dev]'
-
You should be able to run
jupyter lab
and run the following to see the widget:
from jupyter_notepad.widget import Widget
w = Widget()
w
Enable extension:
Make sure you've installed or run pnpm build:prod
first.
- Jupyter notebook 5.2 and earlier:
jupyter nbextension install --sys-prefix --symlink --overwrite --py lmk
jupyter nbextension enable --sys-prefix --py lmk
- Jupyterlab:
jupyter labextension develop --overwrite .
Watch (dev mode)
pnpm watch
When this is running, if you make changes to the plugin code reloading the page should be sufficient to see changes.
Linting & formatting
pnpm check
Build python wheel
pnpm build:python
- TODO: clean up JS dependencies
Project details
Release history Release notifications | RSS feed
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 jupyter_notepad-0.0.1.dev2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95694994fb66d76f1aaa8c2e5af0a9051de7482bd59f99d782acb96c631f0623 |
|
MD5 | 36b1e85f3b1de9659a8fd6a9f8f0ebc6 |
|
BLAKE2b-256 | 205a4a3466a386f2a193d8118758d44821550fb07b8bc5717921f37eef93a945 |
Hashes for jupyter_notepad-0.0.1.dev2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba55a0a0af188f9b9d43f7608ac48afa56c9097b504e16b9d05c575910305290 |
|
MD5 | 3640fb47ab7ed64c5e95c829675b810c |
|
BLAKE2b-256 | 5fa71f3393f880de74c074f54d6a179d48075df4fc2f5b8d62c8326d0e11dcd0 |