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-1.0.1.tar.gz (3.7 MB view details)

Uploaded Source

Built Distribution

vegafusion_jupyter-1.0.1-py3-none-any.whl (7.5 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vegafusion-jupyter-1.0.1.tar.gz
  • Upload date:
  • Size: 3.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for vegafusion-jupyter-1.0.1.tar.gz
Algorithm Hash digest
SHA256 66de1a99b54bcbc6dd7e8d9511e57e5a1ed2052b69e7a0fc906f26558810905f
MD5 a2f61332801bc491b56fc590a259e2d2
BLAKE2b-256 d2450867c519f8e5e95c1607d49b7930bd01c48c43a3ba1860185717687c166a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vegafusion_jupyter-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7c7c126625416b55e89d5d3328867d00d6ce3ba02d83acadd6bd28ae16ee1a4a
MD5 9dba7c1c3a466fe4b3a0a046a1d5cbb1
BLAKE2b-256 8018c5a7622ae38885c6138e6d4d9aefa679f56cdec92f94aa0dc0a9b5158501

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