Skip to main content

A Custom Jupyter Widget Library

Project description

demo_widgets

[![Build Status](https://travis-ci.org/Training 4 Developers LLC/demo_widgets.svg?branch=master)](https://travis-ci.org/Training 4 Developers LLC/demo_widgets) [![codecov](https://codecov.io/gh/Training 4 Developers LLC/demo_widgets/branch/master/graph/badge.svg)](https://codecov.io/gh/Training 4 Developers LLC/demo_widgets)

A Custom Jupyter Widget Library

Installation

You can install using pip:

pip install demo_widgets

If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable the nbextension:

jupyter nbextension enable --py [--sys-prefix|--user|--system] demo_widgets

Development Installation

Create a dev environment:

conda create -n demo_widgets-dev -c conda-forge nodejs yarn python jupyterlab
conda activate demo_widgets-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 demo_widgets
jupyter nbextension enable --sys-prefix --py demo_widgets

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.

Updating the version

To update the version, install tbump and use it to bump the version. By default it will also create a tag.

pip install tbump
tbump <new-version>

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

demo_widgets-0.1.4.tar.gz (1.2 MB view hashes)

Uploaded Source

Built Distribution

demo_widgets-0.1.4-py3-none-any.whl (2.1 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page