2016-11-10 02:08:22 -05:00
Superset
2015-07-02 18:16:59 -04:00
=========
2016-11-10 02:08:22 -05:00
[![Build Status ](https://travis-ci.org/airbnb/superset.svg?branch=master )](https://travis-ci.org/airbnb/superset)
[![PyPI version ](https://badge.fury.io/py/superset.svg )](https://badge.fury.io/py/superset)
[![Coverage Status ](https://coveralls.io/repos/airbnb/superset/badge.svg?branch=master&service=github )](https://coveralls.io/github/airbnb/superset?branch=master)
[![JS Test Coverage ](https://codeclimate.com/github/airbnb/superset/badges/coverage.svg )](https://codeclimate.com/github/airbnb/superset/coverage)
[![Code Health ](https://landscape.io/github/airbnb/superset/master/landscape.svg?style=flat )](https://landscape.io/github/airbnb/superset/master)
[![Code Climate ](https://codeclimate.com/github/airbnb/superset/badges/gpa.svg )](https://codeclimate.com/github/airbnb/superset)
[![PyPI ](https://img.shields.io/pypi/pyversions/superset.svg?maxAge=2592000 )](https://pypi.python.org/pypi/superset)
[![Requirements Status ](https://requires.io/github/airbnb/superset/requirements.svg?branch=master )](https://requires.io/github/airbnb/superset/requirements/?branch=master)
[![Join the chat at https://gitter.im/airbnb/superset ](https://badges.gitter.im/airbnb/superset.svg )](https://gitter.im/airbnb/superset?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
[![Documentation ](https://img.shields.io/badge/docs-airbnb.io-blue.svg )](http://airbnb.io/superset/)
[![dependencies Status ](https://david-dm.org/airbnb/superset/status.svg?path=superset/assets )](https://david-dm.org/airbnb/superset?path=superset/assets)
2016-11-10 12:41:09 -05:00
**Superset** is a data exploration platform designed to be visual, intuitive
2015-08-08 11:02:56 -04:00
and interactive.
2016-11-10 12:41:09 -05:00
[this project used to be named **Caravel** , and **Panoramix** in the past]
2016-03-19 19:09:08 -04:00
2016-01-27 16:56:23 -05:00
2016-09-14 19:39:40 -04:00
Screenshots & Gifs
------------------
2016-01-27 16:56:23 -05:00
2016-11-17 14:45:40 -05:00
**View Dashboards**
![superset-dashboard ](https://cloud.githubusercontent.com/assets/130878/20371438/a703a2a0-ac19-11e6-80c4-00a47c2eb644.gif )
2016-09-14 19:39:40 -04:00
2016-11-17 14:45:40 -05:00
< br / >
**View/Edit a Slice**
![superset-explore-slice ](https://cloud.githubusercontent.com/assets/130878/20372732/410392f4-ac22-11e6-9c6d-3ef512e81212.gif )
2016-09-14 19:39:40 -04:00
2016-11-17 14:45:40 -05:00
< br / >
**Query and Visualize with SQL Lab**
![superset-sql-lab-visualization ](https://cloud.githubusercontent.com/assets/130878/20372911/7c3b3358-ac23-11e6-8f24-923ef1b35715.gif )
2016-09-14 19:39:40 -04:00
2016-11-17 14:45:40 -05:00
< br / >
![superset-dashboard-misc ](https://cloud.githubusercontent.com/assets/130878/20234704/0f40778c-a835-11e6-9556-983a62ea061b.png )
![superset-edit-table ](https://cloud.githubusercontent.com/assets/130878/20234705/0f415c88-a835-11e6-8b03-f7c35d56dd7d.png )
![superset-query-search ](https://cloud.githubusercontent.com/assets/130878/20234706/0f430a10-a835-11e6-8a0d-8b26cc2e6bbd.png )
2015-09-21 16:48:02 -04:00
2016-11-10 02:08:22 -05:00
Superset
2015-09-21 16:48:02 -04:00
---------
2016-11-10 02:08:22 -05:00
Superset's main goal is to make it easy to slice, dice and visualize data.
2016-03-31 15:38:34 -04:00
It empowers users to perform **analytics at the speed of thought** .
2015-09-21 16:48:02 -04:00
2016-11-10 02:08:22 -05:00
Superset provides:
2016-04-06 20:54:41 -04:00
* A quick way to intuitively visualize datasets by allowing users to create
and share interactive dashboards
2015-09-21 16:48:02 -04:00
* A rich set of visualizations to analyze your data, as well as a flexible
way to extend the capabilities
* An extensible, high granularity security model allowing intricate rules
on who can access which features, and integration with major
authentication providers (database, OpenID, LDAP, OAuth & REMOTE_USER
through Flask AppBuiler)
2016-03-19 13:07:18 -04:00
* A simple semantic layer, allowing to control how data sources are
2016-04-06 20:54:41 -04:00
displayed in the UI, by defining which fields should show up in
which dropdown and which aggregation and function (metrics) are
made available to the user
2016-11-10 02:08:22 -05:00
* Deep integration with Druid allows for Superset to stay blazing fast while
2015-09-21 16:48:02 -04:00
slicing and dicing large, realtime datasets
2016-06-13 12:25:22 -04:00
* Fast loading dashboards with configurable caching
2015-09-21 16:48:02 -04:00
2015-08-08 11:02:56 -04:00
Database Support
----------------
2016-11-10 02:08:22 -05:00
Superset was originally designed on top of Druid.io, but quickly broadened
2016-04-06 20:54:41 -04:00
its scope to support other databases through the use of SQLAlchemy, a Python
2015-09-21 16:48:02 -04:00
ORM that is compatible with
2016-03-16 23:25:41 -04:00
[most common databases ](http://docs.sqlalchemy.org/en/rel_1_0/core/engines.html ).
2015-09-21 16:48:02 -04:00
2015-08-08 11:02:56 -04:00
2015-09-21 16:48:02 -04:00
What is Druid?
2015-07-15 21:01:25 -04:00
-------------
From their website at http://druid.io
2016-03-16 23:25:41 -04:00
*Druid is an open-source analytics data store designed for
business intelligence (OLAP) queries on event data. Druid provides low
latency (real-time) data ingestion, flexible data exploration,
and fast data aggregation. Existing Druid deployments have scaled to
trillions of events and petabytes of data. Druid is best used to
2015-07-15 21:01:25 -04:00
power analytic dashboards and applications.*
2015-07-22 11:53:38 -04:00
2016-03-16 23:25:41 -04:00
Installation & Configuration
----------------------------
2015-09-05 12:23:46 -04:00
2016-11-10 02:08:22 -05:00
[See in the documentation ](http://airbnb.io/superset/installation.html )
2015-09-05 12:23:46 -04:00
2015-09-05 17:27:18 -04:00
More screenshots
----------------
2016-11-17 14:45:40 -05:00
![superset-security-menu ](https://cloud.githubusercontent.com/assets/130878/20234707/0f565886-a835-11e6-9277-b4f5f4aa2fcc.png )
![superset-slice-bubble ](https://cloud.githubusercontent.com/assets/130878/20234708/0f57f3d0-a835-11e6-8268-fcefe8f868c8.png )
2016-09-14 19:39:40 -04:00
2016-11-17 14:45:40 -05:00
![superset-slice-map ](https://cloud.githubusercontent.com/assets/130878/20234709/0f5a5a44-a835-11e6-987a-1b6f8ac9922b.png )
2016-09-14 19:39:40 -04:00
2016-11-17 14:45:40 -05:00
![superset-slice-multiline ](https://cloud.githubusercontent.com/assets/130878/20234710/0f632d68-a835-11e6-98d1-542dcb618193.png )
2016-09-14 19:39:40 -04:00
2016-11-17 14:45:40 -05:00
![superset-slice-sankey ](https://cloud.githubusercontent.com/assets/130878/20234711/0f639136-a835-11e6-8721-fe5e48dab8e7.png )
2016-09-14 19:39:40 -04:00
2016-11-17 14:45:40 -05:00
![superset-slice-view ](https://cloud.githubusercontent.com/assets/130878/20234712/0f63c4c6-a835-11e6-8595-6091a6428fa9.png )
2016-09-14 19:39:40 -04:00
2016-11-17 14:45:40 -05:00
![superset-sql-lab-2 ](https://cloud.githubusercontent.com/assets/130878/20234713/0f67b856-a835-11e6-9d50-7a52168f66fd.png )
2016-09-14 19:39:40 -04:00
2016-11-17 14:45:40 -05:00
![superset-sql-lab ](https://cloud.githubusercontent.com/assets/130878/20234714/0f68f45a-a835-11e6-9467-f47ad0af7e79.png )
2016-03-29 14:11:13 -04:00
2015-09-27 21:02:00 -04:00
2016-04-01 19:16:21 -04:00
Resources
2015-12-11 11:51:13 -05:00
-------------
2016-11-10 02:08:22 -05:00
* [Superset Google Group ](https://groups.google.com/forum/#!forum/airbnb_superset )
* [Gitter (live chat) Channel ](https://gitter.im/airbnb/superset )
2016-11-12 22:32:39 -05:00
* [Docker image ](https://hub.docker.com/r/amancevice/superset/ ) (community contributed)
2016-04-07 17:38:23 -04:00
* [Slides from Strata (March 2016) ](https://drive.google.com/open?id=0B5PVE0gzO81oOVJkdF9aNkJMSmM )
2015-12-11 11:51:13 -05:00
2015-09-27 21:02:00 -04:00
Tip of the Hat
--------------
2016-11-10 02:08:22 -05:00
Superset would not be possible without these great frameworks / libs
2015-09-27 21:02:00 -04:00
* Flask App Builder - Allowing us to focus on building the app quickly while
getting the foundation for free
* The Flask ecosystem - Simply amazing. So much Plug, easy play.
2016-03-31 15:38:34 -04:00
* NVD3 - One of the best charting libraries out there
2016-11-10 02:08:22 -05:00
* Much more, check out the `install_requires` section in the [setup.py ](https://github.com/airbnb/superset/blob/master/setup.py ) file!
2016-02-27 10:47:56 -05:00
Contributing
------------
2016-11-10 02:08:22 -05:00
Interested in contributing? Casual hacking? Check out [Contributing.MD ](https://github.com/airbnb/superset/blob/master/CONTRIBUTING.md )