IPython/Jupyter notebook module for Vega and Vega-Lite
Jupyter Notebook Python TypeScript JavaScript
Clone or download
Latest commit 2035d1a Jul 2, 2018

README.md

IPython Vega

PyPI Build Status

IPython/Jupyter notebook module for Vega 3, and Vega-Lite 2. Notebooks with embedded visualizations can be viewed on GitHub and nbviewer.

Available on pypi.

Install and run

Python Package Index

To install vega and its dependencies from the Python Package Index using pip, use the following commands:

pip install jupyter pandas vega
pip install --upgrade notebook  # need jupyter_client >= 4.2 for sys-prefix below
jupyter nbextension install --sys-prefix --py vega  # not needed in notebook >= 5.3

Conda Forge

If you use conda, you probably already have the latest versions of the notebook and pandas installed. To install vega extension run:

conda install vega

From Source

To install from source, make sure you have jupyter and pandas installed, then download this repository and run

python setup.py install

Usage

Once the package is installed, run

jupyter notebook

to launch the Jupyter notebook server, and use vega within the notebook. See the example notebooks for Vega-Lite and Vega.

To run the notebooks yourself, you need to get the file cars.json.

Developers

Install requirements: pip install -r requirements.txt

Symlink files instead of copying files:

python setup.py develop
jupyter nbextension install --py --symlink vega  # not needed in notebook >= 5.3

Run kernel: jupyter notebook

To rebuild the javascript continuously, run yarn watch.

Publish a new version to pypi with python3 setup.py sdist upload.

How to make a release

  • Update the javascript dependendencies by changing package.json (e.g. with ncu)
  • Run yarn
  • Rebuild the javascript with yarn build
  • Make sure that everything still works (launch notebook and try the examples)
  • Update the version number in package.json and __index__.py and add a git tag
  • git push
  • Run python setup.py sdist upload to update https://pypi.python.org/pypi/vega