IPython/Jupyter notebook module for Vega and Vega-Lite
Jupyter Notebook Python JavaScript HTML
Latest commit 7e8ed67 Oct 19, 2016 @domoritz domoritz Support vega-lite 1.2.1

README.md

IPython Vega PyPI Build Status

IPython/Jupyter notebook module for Vega, and Vega-Lite, Polestar, and Voyager. Notebooks with embedded visualizations can be viewed on github and nbviewer.

Available on pypi and conda-forge.

screenshot

Install and run

Conda (Recommended)

If you are using conda you can install the most recent release of this package from the conda-forge channel as follows:

conda install vega --channel conda-forge

The above command automatically installs all dependencies and enables the ipyvega Jupyter notebook extension.

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
jupyter nbextension install --py 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

Run kernel: jupyter notebook

To rebuild the javascript continuously, run npm run 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
  • Run npm update
  • Rebuild the javascript with npm run build
  • Make sure that everything still works (launch notebook and try the examples)
  • Update the version number in package.json and __index__.py
  • Commit and add a version tag of the form v0.0.0
  • git push --tags && git push
  • Run python setup.py sdist upload to update https://pypi.python.org/pypi?%3Aaction=pkg_edit&name=vega

Resources

How to implement an nbextension.