Skip to content

Build interactive big data apps with Altair and Vega easily using Panel + VegaFusion.

License

Notifications You must be signed in to change notification settings

awesome-panel/panel-vegafusion

Repository files navigation

Python Versions License: AGPL v3 Binder Follow on Twitter

Panel VegaFusion

WORK IN PROGRESS. PROOF OF CONCEPT WORKING.

The Panel VegaFusion pane allows you to create interactive big data apps based on the Altair plotting library and the Vega visualization specification.

VegaFusion provides serverside acceleration for the Vega visualization grammar.

Panel makes it easy to create powerful data apps using the tools you know and ❤️. Member of the HoloViz ecosystem.

Reference Example

Install

pip install panel-vegafusion

If you have Jupyter Lab installed and plan on using it you should definately also install the Panel Jupyterlab Preview via

jupyter serverextension enable panel.io.jupyter_server_extension

Example

import altair as alt
import panel as pn
from panel_vegafusion import VegaFusion
from panel_vegafusion.utils import get_plot, ALTAIR_BLUE, get_theme

pn.extension(template="fast")

theme=get_theme()
alt.themes.enable(theme)

plot=get_plot() # Can be replaced by any Altair plot or Vega Specification

component = VegaFusion(plot, height=800).servable()

pn.state.template.param.update(
    site="Panel VegaFusion", title="Interactive BIG DATA apps with CROSSFILTERING for Altair and Vega",
    accent_base_color=ALTAIR_BLUE, header_background=ALTAIR_BLUE,
)

You can serve the application via panel serve name_of_file.py or panel serve name_of_notebook.ipynb. Add the --autoreload for hot reload during development and --show to automatically open the app in the browser.

License - AGPLv3 - IMPORTANT

This Panel Vegafusion project is AGPLv3 Licensed because VegaFusion is AGPLv3 licensed and requires the author to provide this application's source code upon request.

SO PLEASE INVESTIGATE THE LEGAL ASPECTS ON YOUR OWN. YOU WILL BE USING THIS PROJECT AT YOUR OWN RISK ANYWAYS! 👍

Legal Statement

References

Issues Identified

Develop

Install for development

git clone https://github.com/MarcSkovMadsen/panel-vegafusion.git
conda create -n panel_vegafusion -c conda-forge python=3.9 nodejs
conda activate panel_vegafusion
pip install -e .[all]
cd src-js
npm install
cd ..

Build

Javascript package

invoke build.js

Python package

invoke build.package

Test

invoke test.all

Serve Dev App

For now you can serve an example with hot reload via

panel serve 'tests/apps/test_dev_app.py' --autoreload --show

Panel VegaFusion Test App

Serve Example Apps

For now you can serve an example with hot reload via

panel serve 'examples/*.py' --autoreload --show

Reference

You can also find inspiration in the original Jupyter VegaFusion reference example via

jupyter lab tests/reference_example.ipynb

Release Python Package

Before releasing please make sures you have

  • updated all version numbers
  • build all packages
  • run all tests with succes
python -m twine upload dist/*<VERSION>*

to deploy the package 📦.

If you want to upload to testpypi first you can do so by adding --repository testpypi.