Skip to main content

Altair Jupyter Widget library that relies on VegaFusion for serverside calculations

Project description

VegaFusion Jupyter

This directory contains the vegafusion-jupyter package. For documentation on using this package to display Altair visualizations powered by VegaFusion in Jupyter contexts, see https://vegafusion.io.

The content below was autogenerated by Jupyter Widget cookiecutter

vegafusion-jupyter

Build Status codecov

Altair Jupyter Widget library that relies on VegaFusion for serverside calculations

Installation

You can install using pip:

pip install vegafusion_jupyter

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] vegafusion_jupyter

Development Installation

Create a dev environment:

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

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

vegafusion-jupyter-0.7.0.tar.gz (3.0 MB view details)

Uploaded Source

Built Distribution

vegafusion_jupyter-0.7.0-py3-none-any.whl (6.1 MB view details)

Uploaded Python 3

File details

Details for the file vegafusion-jupyter-0.7.0.tar.gz.

File metadata

  • Download URL: vegafusion-jupyter-0.7.0.tar.gz
  • Upload date:
  • Size: 3.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for vegafusion-jupyter-0.7.0.tar.gz
Algorithm Hash digest
SHA256 06816a0abb18f7d9b300588d0bf86cfb54c650ff3133415c742382986e08337e
MD5 275c1c384cfc1327ef1ed462e317a3a9
BLAKE2b-256 d4f674b8bed33c88f5b7a180dce62dba2428102803acc830ebe6d0ee0050fccb

See more details on using hashes here.

File details

Details for the file vegafusion_jupyter-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: vegafusion_jupyter-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 6.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.2

File hashes

Hashes for vegafusion_jupyter-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ecdc6a1b627f4dcb4a179c434405df69266b55128faeb8324ba4323ba6bbdcd1
MD5 05ea004efa9061c97f61c5185dc54d6d
BLAKE2b-256 8ad8a30359483ce6ecbfe6c7507be3dea9eaddf7605fc42a835764f207d0a8d1

See more details on using hashes here.

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