ipywidgethello¶

Version: 0.2.3

Hello world for widgets!

Quickstart¶

To get started with ipywidgethello, install with pip:

pip install ipywidgethello

or with conda:

conda install ipywidgethello

Contents¶

Installation¶

The simplest way to install ipywidgethello is via pip:

pip install ipywidgethello

or via conda:

conda install ipywidgethello

If you installed via pip, and notebook version < 5.3, you will also have to install / configure the front-end extension as well. If you are using classic notebook (as opposed to Jupyterlab), run:

jupyter nbextension install [--sys-prefix / --user / --system] --py ipywidgethello

jupyter nbextension enable [--sys-prefix / --user / --system] --py ipywidgethello

with the appropriate flag. If you are using Jupyterlab, install the extension with:

jupyter labextension install jupyter-widget-hello

If you are installing using conda, these commands should be unnecessary, but If you need to run them the commands should be the same (just make sure you choose the –sys-prefix flag).

Examples¶

This section contains several examples generated from Jupyter notebooks. The widgets have been embedded into the page.

Hello World!¶

In [1]:

import ipywidgethello

In [2]:

w = ipywidgethello.ExampleWidget()

In [3]:

assert w.value == 'Hello World'

Developer install¶

To install a developer version of ipywidgethello, you will first need to clone the repository:

git clone https://github.com/vidartf/jupyter-widget-hello
cd jupyter-widget-hello

Next, install it with a develop install using pip:

pip install -e .

If you are planning on working on the JS/frontend code, you should also do a link installation of the extension:

jupyter nbextension install [--sys-prefix / --user / --system] --symlink --py ipywidgethello

jupyter nbextension enable [--sys-prefix / --user / --system] --py ipywidgethello

with the appropriate flag. Or, if you are using Jupyterlab:

jupyter labextension link .