Metadata-Version: 2.1
Name: ipyvizzu
Version: 0.5.0
Summary: Jupyter notebook integration for vizzu
Home-page: https://github.com/vizzuhq/ipyvizzu
License: Apache 2
Project-URL: Documentation, https://vizzuhq.github.io/ipyvizzu/index.html
Project-URL: Source, https://github.com/vizzuhq/ipyvizzu
Project-URL: Tracker, https://github.com/vizzuhq/ipyvizzu/issues
Description: [![Makefile CI](https://github.com/nyirog/ipyvizzu/actions/workflows/makefile.yml/badge.svg?branch=main)](https://github.com/nyirog/ipyvizzu/actions/workflows/makefile.yml)
        
        # ipyvizzu
        
        Jupyter notebook integration for [Vizzu](https://lib.vizzuhq.com/).
        
        ipyvizzu only works in jupiter notebook environment. A notebook cell may
        contain the following code snippet.
        
        ```python
        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.
        
        ```sh
        pip install ipyvizzu
        pip install notebook
        ```
        
        ipyvizzu loads Vizzu from [jsDelivr](https://www.jsdelivr.com/package/npm/vizzu) by default, but a local copy of it can be used.
        
        Install a local copy of Vizzu.
        
        ```sh
        npm install vizzu@~0.4.0
        ```
        
        Set up Vizzu in the constructor of the Chart class.
        
        ```python
        from ipyvizzu import Chart
        
        chart = Chart(vizzu="./node_modules/vizzu/dist/vizzu.min.js")
        ```
        
        ## Documentation
        
        Documentation can be build with the `doc` make target.
        
        ```sh
        make doc
        ```
        
        Online version can be read at [vizzuhq.github.io/ipyvizzu](https://vizzuhq.github.io/ipyvizzu/index.html).
        
        ## CI check
        
        The `check` make target collects the targets which are run by the CI server.
        
        ```sh
        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.
        
        ```sh
        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`.
        
        ```sh
        make check-format
        ```
        
        `black` can be run with the `format` make target.
        
        ```sh
        make format
        ```
        
        ### Linter
        
        The `lint` target runs `pylint` over the ipyvizzu project.
        
        ```sh
        make lint
        ```
        
        ## Development
        
        ### Release
        
        Plese read the [release guide](RELEASE.md).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Requires-Python: >=3.6
Description-Content-Type: text/markdown
