Skip to content

Latest commit

 

History

History
130 lines (89 loc) · 4.49 KB

README.md

File metadata and controls

130 lines (89 loc) · 4.49 KB
Raw

build status coverage Documentation Status PyPI Version

IPython-Dashboard

A stand alone, light-weight web server for building, sharing graphs created in ipython. Build for data science, data analysis guys. Building an interactive visualization, collaborated dashboard, and real-time streaming graph.

Goal

  • support raw html visualization
  • support python object visualization
  • Editable
  • Real-time fresh when rendering a variable python object
  • Can be shared, both public and private [ need password ]
  • In the notebook, can share an object to a dashboard [ that's visualise that object in that dashboard ]

Raw Design

  • C/S model
  • Server can interact with IPython kernel directly or indirectly
  • Client get data from server internally or server push data to client
  • Client consists of several boxes, each box is an independent front-side object, and is editable and drag to rearrange the place to hold it.

architecture

Screenshot & Demo

demo demo

Run tests

just run sudo nosetests --with-coverage --cover-package=dashboard under this repo

aaron@aarons-MacBook-Pro:~/Desktop/github/IPython-Dashboard$sudo nosetests --with-coverage --cover-package=dashboard
...
Name                                    Stmts   Miss  Cover   Missing
---------------------------------------------------------------------
dashboard.py                                9      0   100%
dashboard/client.py                         1      0   100%
dashboard/client/sender.py                 11      9    18%   22-34
dashboard/config.py                        12      0   100%
dashboard/server.py                         1      0   100%
dashboard/server/resources.py               0      0   100%
dashboard/server/resources/dash.py         41     25    39%   25-30, 39, 48-49, 55-71, 76-87
dashboard/server/resources/home.py          8      1    88%   20
dashboard/server/resources/storage.py      15      7    53%   20-22, 30-34
dashboard/server/utils.py                  31      6    81%   18-22, 29, 43
dashboard/server/views.py                  12      0   100%
---------------------------------------------------------------------
TOTAL                                     141     48    66%
----------------------------------------------------------------------
Ran 3 tests in 0.345s

OK

Related Projects & Products

Change Log

  • V 0.3.0

    • import dashboard to ipython notebook, one click [ though I don't think it's necessary]

  • V 0.2.2

    • front side, databricks style
    • pep 8, code clean up & restructure
    • hover tips
    • edit modal can be resized

  • V 0.2.1

    • Share one graph
    • Share one dashboard
    • Presentation mode
    • slogan
    • footer
    • readthedoc

  • V 0.2 [current]

    • Interact with server [ CURD ]
    • Simple visualization
    • Rearrange buttons [ add, share ]
    • Dash json format
      • dash number [list]
      • content name
      • content type
    • docstring

  • V 0.1

    • Add dashboard client template
    • Template consists of box, each box is an independent front-side object
    • Template hierarchy:
      • box page [add, delete, share one or all]
      • box graph [add, delete, share one or all]
      • rename