Skip to content

Commit

Permalink
Still working on set up
Browse files Browse the repository at this point in the history
  • Loading branch information
parrt committed Aug 26, 2017
1 parent 02549e5 commit 88d1e19
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 2 deletions.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,27 @@
# lolviz
A simple Python data-structure visualization tool for lists of lists, lists, dictionaries; primarily for use in Jupyter notebooks / presentations

A simple Python data-structure visualization tool for lists of lists, lists, dictionaries; primarily for use in Jupyter notebooks / presentations. It seems that I'm always trying to describe how data is laid out in memory to students. There are really great data structure visualization tools but I wanted something I could use directly via Python in Jupyter notebooks. The look and idea was inspired by the awesome [Python tutor](http://www.pythontutor.com).

There are currently three functions of interest:

* `dictviz()` A dictionary visualization
* `listviz()`
* `lolviz()`

## Installation

```bash
$ pip install lolviz
```

## Usage

From within generic Python,

```python
from lolviz import *
g = listviz(['hi','mom',{3,4},{"parrt":"user"}])
g.render(view=True)
```

<img src="images/list.png" width=200>
Binary file added images/list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

setup(
name='lolviz',
version='1.0.1',
version='1.0.2',
url='https://github.com/parrt/lolviz',
license='BSD',
py_modules=['lolviz'],
author='Terence Parr',
author_email='[email protected]',
install_requires=['graphviz'],
Expand Down

0 comments on commit 88d1e19

Please sign in to comment.