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.dev4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 417d23fa3539ecb1b150fb6d3e204441920f77ef989edbd740126d5f22260234 |
|
MD5 | aa2fc8aefe59d58d2d78c5a659fc0a4b |
|
BLAKE2b-256 | 48083a0b2c295aef65f10d8b1685c89e76e38d0a9ff4b00c19776a882a6b2843 |
Hashes for jupyter_notepad-0.0.1.dev4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f86beba8aa8d51922265e41b612dfd503c210475931ce21a04961cf5501dba8 |
|
MD5 | 801903b07a692bcdc0bdbc70a0c4018d |
|
BLAKE2b-256 | 7950bbddb29c4d6a64425a3c25c200a05e7d8c217392b58de769a5c3ee622511 |