hahnlee / ipytracer

:bar_chart: Algorithm Visualizer for IPython/Jupyter Notebook

ipytracer

Algorithm Visualizer for Jupyter/IPython Notebook

Inspired by parkjs814's AlgorithmVisualizer.

Master	Latest(0.2.2)

Algorithm Visualizer for Jupyter/IPython Notebook.

It was inspired by parkjs814's AlgorithmVisualizer.

You can see how your Python code works.

If you use the display(TracerObject) code from where you want to see, you can use it without any special modification.

Supports built-in list methods.

Development Status

Pre-Alpha

Todo

• Add more tracer api
• Support non-built-in data type in python

Installation

Requirement

• Jupyter/IPython Notebook (Python3.x)

To install use pip:

$ pip install ipytracer
$ jupyter nbextension enable --py --sys-prefix ipytracer

For a development installation (requires npm),

Pre installation

$ npm install -g webpack

Installation

$ git clone https://github.com/sn0wle0pard/ipytracer.git
$ cd ipytracer
$ pip install -e .
$ jupyter nbextension install --py --symlink --sys-prefix ipytracer
$ jupyter nbextension enable --py --sys-prefix ipytracer

Demo

Youtube Video

https://youtu.be/vZQJ0Y3GtIs

Tracers

List1DTracer

Display	Get Item	Set Item

List2DTracer

Get Item	Set Item

ChartTracer

Display	Get Item	Set Item

Bubble Sort

import ipytracer
from IPython.core.display import display

def bubble_sort(unsorted_list):
    x = ipytracer.ChartTracer(unsorted_list)
    display(x)
    length = len(x)-1
    for i in range(length):
        for j in range(length-i):
            if x[j] > x[j+1]:
                x[j], x[j+1] = x[j+1], x[j]
    return x.tolist()

bubble_sort([6,4,7,9,3,5,1,8,2])

You can see more example here

Third Party Libraries

• Chart.js - http://www.chartjs.org
• IPython - https://ipython.org
• ipywidgets - https://ipywidgets.readthedocs.io
• traitlets - https://traitlets.readthedocs.io/
• Underscore - http://underscorejs.org
• Webpack - https://webpack.github.io

See Also NOTICE.md

Author

Han Lee / @sn0wle0pard

License

The Clear BSD License

Copyright (c) 2015-2017, Han Lee
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted (subject to the limitations in the disclaimer
below) provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS
LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.

ipytracer's Issues

Support advanced data types

In versions less than 1.1.0, Tracer.py only support list data type. We want to support a data type that is not default in Python(such as tree). The goal of tracer.py is 'easy to use library for those who are learning programming for the first time'. Therefore, We will design carefully.

ChartTracer Not visuable

Can not save ipynb after running ChartTracer

If I try to save after running ChartTracer, I get the following error:
Uncaught (in promise) TypeError: Converting circular structure to JSON at JSON.stringify (<anonymous>)

Sometimes element values of List1DTracer are not updated.

Often, the element value of X is not changed. It seems to be a problem with the front end.

Support Eventful list

notify trait support

Now this is the way data = _data[:], but it would be better to inherit traitlets and use it.
link: https://github.com/ipython/traitlets

"ImportError: cannot import name 'observe'"

Hi, using python 3.6.1, venv, Jupyter v 5.0.0, I just tried the bubblesort demo in a fresh venv and got "ImportError: cannot import name 'observe'". Stack trace + $ pip freee.

Support 2D List

Support npm and Chart.js

ChartTracer Soon support javascript. I will support npm in setup.py and ChartTracer Support Chart.js

Support traitlets to List1DTracer