A Custom Jupyter Widget Library
Project description
@educational-technology-collective/etc_jupyterlab_distribution
A Custom Jupyter Widget Library
Installation
You can install using pip
:
pip install ipywidgets
pip install etc_jupyterlab_distribution
Development Installation
Create a dev environment:
conda create -n etc_jupyterlab_distribution-dev -c conda-forge nodejs yarn python jupyterlab
conda activate etc_jupyterlab_distribution-dev
Install the python. This will also build the TS package.
pip install -e ".[test, examples]"
When developing your extensions, you need to manually enable your extensions with the notebook / lab frontend. For lab, this is done by the command:
jupyter labextension develop --overwrite .
yarn run build
For classic notebook, you need to run:
jupyter nbextension install --sys-prefix --symlink --overwrite --py etc_jupyterlab_distribution
jupyter nbextension enable --sys-prefix --py etc_jupyterlab_distribution
Note that the --symlink
flag doesn't work on Windows, so you will here have to run
the install
command every time that you rebuild your extension. For certain installations
you might also need another flag instead of --sys-prefix
, but we won't cover the meaning
of those flags here.
How to see your changes
Typescript:
If you use JupyterLab to develop then 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 widget.
# Watch the source directory in one terminal, automatically rebuilding when needed
yarn run watch
# Run JupyterLab in another terminal
jupyter lab
After a change wait for the build to finish and then refresh your browser and the changes should take effect.
Python:
If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.
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
File details
Details for the file etc_jupyterlab_distribution-0.1.2.tar.gz
.
File metadata
- Download URL: etc_jupyterlab_distribution-0.1.2.tar.gz
- Upload date:
- Size: 72.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 59fc0fb951cad8dcbe24106c1f638f31ecdc25a9ac0335e02e240cf47d815868 |
|
MD5 | e73bae9f5c9703ca700c668f9b4dc372 |
|
BLAKE2b-256 | f7719eef82cc61209363bf9a1ef4145ef81d286dcc46ec14c73c3f2892495485 |
File details
Details for the file etc_jupyterlab_distribution-0.1.2-py2.py3-none-any.whl
.
File metadata
- Download URL: etc_jupyterlab_distribution-0.1.2-py2.py3-none-any.whl
- Upload date:
- Size: 142.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45c17010b049fdf48f382749dfc2521a0145d72497fbb11d039b6a9c7c84a6b3 |
|
MD5 | 250ffd2a730d569b695cb14eccccacb3 |
|
BLAKE2b-256 | 37af22136f8593ce7e69c0e87e90d424e997cb3705d24ba33ff5426868b8ae32 |