https://github.com/cabreraalex/widget-svelte-example

A simple Jupyter Widget using Svelte
https://github.com/cabreraalex/widget-svelte-example

Last synced: about 1 month ago
JSON representation

A simple Jupyter Widget using Svelte

• Host: GitHub
• URL: https://github.com/cabreraalex/widget-svelte-example
• Owner: cabreraalex
• License: bsd-3-clause
• Created: 2020-11-08T20:19:05.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-04T16:10:55.000Z (almost 4 years ago)
• Last Synced: 2023-08-28T10:54:45.917Z (about 1 year ago)
• Language: Python
• Size: 18.6 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# widget-svelte-example

A Custom Jupyter Widget Library

## Installation

You can install using `pip`:

```bash

pip install widget_svelte_example

```

Or if you use jupyterlab:

```bash

pip install widget_svelte_example

jupyter labextension install @jupyter-widgets/jupyterlab-manager

```

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

the nbextension:

```bash

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

```

## Development Installation

```bash

# First install the python package. This will also build the JS packages.

pip install -e .

```

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 install @jupyter-widgets/jupyterlab-manager --no-build

jupyter labextension install .

```

For classic notebook, you can run:

```

jupyter nbextension install --sys-prefix --symlink --overwrite --py widget_svelte_example

jupyter nbextension enable --sys-prefix --py widget_svelte_example

```

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:

To continuously monitor the project for changes and automatically trigger a rebuild, start Jupyter in watch mode:

```bash

jupyter lab --watch

```

And in a separate session, begin watching the source directory for changes:

```bash

npm run watch

```

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.