ipyvizzu 0.5.0

Jupyter notebook integration for vizzu

ipyvizzu

Jupyter notebook integration for Vizzu.

ipyvizzu only works in jupiter notebook environment. A notebook cell may contain the following code snippet.

from ipyvizzu import Chart, Data, Config

data = Data()
data.add_series("Foo", ["Alice", "Bob", "Ted"])
data.add_series("Bar", [15, 32, 12])
data.add_series("Baz", [5, 2, 2])

chart = Chart()
chart.animate(data)

chart.animate(x="Foo", y="Bar", color="Foo")
chart.animate(geometry="circle")
chart.animate(x="Foo", y="Baz", color="Foo")
chart.animate(geometry="rectangle")

Installation

ipyvizzu requires only IPython package, but you can use it only in jupyter notebook therefore notebook project has to be installed.

pip install ipyvizzu
pip install notebook

ipyvizzu loads Vizzu from jsDelivr by default, but a local copy of it can be used.

Install a local copy of Vizzu.

npm install vizzu@~0.4.0

Set up Vizzu in the constructor of the Chart class.

from ipyvizzu import Chart

chart = Chart(vizzu="./node_modules/vizzu/dist/vizzu.min.js")

Documentation

Documentation can be build with the doc make target.

make doc

Online version can be read at vizzuhq.github.io/ipyvizzu.

CI check

The check make target collects the targets which are run by the CI server.

make check

Testing

The unit tests can be run with the test make target. As part of the unit tests the notebooks under the docs/examples are executed, too.

make test

Formatting

The ipyvizzu project is formatted with black. The CI check invokes the check-format target to ensure that the python files are formatted with black.

make check-format

black can be run with the format make target.

make format

Linter

The lint target runs pylint over the ipyvizzu project.

make lint

Development

Release

Plese read the release guide.