https://github.com/mshafir/vislib

A library of web-based visualizations for python and ipython
https://github.com/mshafir/vislib

Last synced: 12 days ago
JSON representation

A library of web-based visualizations for python and ipython

• Host: GitHub
• URL: https://github.com/mshafir/vislib
• Owner: mshafir
• License: mit
• Created: 2018-05-22T23:32:41.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-06-07T20:01:29.000Z (over 6 years ago)
• Last Synced: 2024-11-07T23:41:24.400Z (2 months ago)
• Language: Python
• Homepage: https://mshafir.github.io/vislib/
• Size: 1.98 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vislib

https://mshafir.github.io/vislib/

vislib is a library that wraps common javascript visualization libraries. The variety and capabilities of javascript

visualization libraries exceed what exists in python. Though native python libraries will always have better

integration support, the goal here is to provide a quick and dirty way to embed rich html visualizations as iframes into an

ipython environment or generate them as standalone html files.

The core vislib package provides an abstraction that makes it easy to add new wrappers for additional javascript libraries.

It uses the jinja2 templating library and some standard boilerplate templates to expose the raw capabilities of

each library.

Each visualization is an attempt to strike a balance between completeness, consistency, and simplicity for the visualization API.

Feedback is welcome!

## Set Up / Usage

```

pip install vislib

```

*vislib* is set up to optionally be used within an ipython interactive environment.

If used outside of ipython, it will generate html files and open

the default browser with the created visualizations.

## Visualizations

### vis.js timeline

A library for rich interactive timelines.

Renders a vis.js timeline component. See http://visjs.org/docs/timeline/

```python

from vislib.visjs import timeline

timeline([{'text': 'first item', 'start': '2018-05-21 17:30:08.202'},

          {'text': 'second item', 'start': "2018-05-21 17:31:53.712"},

          {'text': 'third item', 'start': "2018-05-21 18:14:05.843"}], content_field='text', title='example1')

```

![alt text](https://github.com/mshafir/vislib/raw/master/images/timeline.png "Timeline")

### Taucharts

A d3 based charting library that elegantly mixes power and simplicity.

Renders a basic taucharts chart with the given data. See https://www.taucharts.com/

```python

from vislib.taucharts import chart

chart([{'item': 'car', 'amount': 1},

       {'item': 'book', 'amount': 10},

       {'item': 'bed', 'amount': 3}], x='item', y='amount', title='Taucharts example')

```

![alt text](https://github.com/mshafir/vislib/raw/master/images/tauchart.png "Tauchart")

### Treant

Renders a Treant.js tree. See http://fperucic.github.io/treant-js/

```python

from vislib.treant import tree

tree({

        'text': { 'name': "Parent node" },

        'children': [{

            'text': { 'name': "First child" }

        },{

            'text': { 'name': "Second child" }

        }]

    })

```

![alt text](https://github.com/mshafir/vislib/raw/master/images/treant.png "Treant")

## Development

### Generate Documentation

```

 cd docs

 rm -rf _build

 make html

```

### Publish

```

rm -rf dist

python setup.py sdist bdist_wheel

twine upload dist/*

```