2016-03-29 00:55:58 -04:00
Caravel
2015-07-02 18:16:59 -04:00
=========
2016-04-03 23:08:36 -04:00
< img src = "http://i.imgur.com/H0Kyvyi.jpg" style = "border-radius: 20px; box-shadow:5px 5px 5px gray;" alt = "Caravel" width = "500" / >
2016-01-06 19:46:40 -05:00
2016-03-30 00:14:44 -04:00
[![Build Status ](https://travis-ci.org/airbnb/caravel.svg?branch=master )](https://travis-ci.org/airbnb/caravel)
2016-03-29 00:55:58 -04:00
[![PyPI version ](https://badge.fury.io/py/caravel.svg )](https://badge.fury.io/py/caravel)
[![Coverage Status ](https://coveralls.io/repos/airbnb/caravel/badge.svg?branch=master&service=github )](https://coveralls.io/github/airbnb/caravel?branch=master)
2016-08-31 16:30:36 -04:00
[![JS Test Coverage ](https://codeclimate.com/github/airbnb/caravel/badges/coverage.svg )](https://codeclimate.com/github/airbnb/caravel/coverage)
2016-03-29 00:55:58 -04:00
[![Code Health ](https://landscape.io/github/airbnb/caravel/master/landscape.svg?style=flat )](https://landscape.io/github/airbnb/caravel/master)
2016-08-31 16:30:36 -04:00
[![Code Climate ](https://codeclimate.com/github/airbnb/caravel/badges/gpa.svg )](https://codeclimate.com/github/airbnb/caravel)
2016-04-28 20:58:09 -04:00
[![PyPI ](https://img.shields.io/pypi/pyversions/caravel.svg?maxAge=2592000 )](https://pypi.python.org/pypi/caravel)
2016-03-29 00:55:58 -04:00
[![Requirements Status ](https://requires.io/github/airbnb/caravel/requirements.svg?branch=master )](https://requires.io/github/airbnb/caravel/requirements/?branch=master)
[![Join the chat at https://gitter.im/airbnb/caravel ](https://badges.gitter.im/airbnb/caravel.svg )](https://gitter.im/airbnb/caravel?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2016-03-30 00:28:43 -04:00
[![Documentation ](https://img.shields.io/badge/docs-airbnb.io-blue.svg )](http://airbnb.io/caravel/)
2016-08-10 23:32:23 -04:00
[![dependencies Status ](https://david-dm.org/airbnb/caravel/status.svg?path=caravel/assets )](https://david-dm.org/airbnb/caravel?path=caravel/assets)
2015-07-02 18:16:59 -04:00
2016-03-29 00:55:58 -04:00
Caravel is a data exploration platform designed to be visual, intuitive
2015-08-08 11:02:56 -04:00
and interactive.
2016-03-19 19:09:08 -04:00
[this project used to be named **Panoramix** ]
2016-01-27 16:56:23 -05:00
2016-09-14 19:39:40 -04:00
Screenshots & Gifs
------------------
![img ](http://g.recordit.co/xFXSvaGUts.gif )
2016-01-27 16:56:23 -05:00
2016-09-14 19:39:40 -04:00
---
![img ](http://g.recordit.co/uZggYOdR5g.gif )
---
![img ](http://g.recordit.co/U70FWLpLvh.gif )
---
2016-06-29 14:00:44 -04:00
![img ](http://i.imgur.com/x8t30YU.png )
2016-09-14 19:39:40 -04:00
---
2016-06-29 14:00:44 -04:00
![img ](http://i.imgur.com/DRCnbq6.png )
2015-09-21 16:48:02 -04:00
2016-03-29 00:55:58 -04:00
Caravel
2015-09-21 16:48:02 -04:00
---------
2016-03-29 00:55:58 -04:00
Caravel'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-03-29 00:55:58 -04:00
Caravel 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-03-29 00:55:58 -04:00
* Deep integration with Druid allows for Caravel 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-03-31 15:02:26 -04:00
Caravel 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-03-31 11:50:47 -04:00
[See in the documentation ](http://airbnb.io/caravel/installation.html )
2015-09-05 12:23:46 -04:00
2015-09-05 17:27:18 -04:00
More screenshots
----------------
2016-06-29 14:00:44 -04:00
![img ](http://i.imgur.com/SAhDJCI.png )
2016-09-14 19:39:40 -04:00
---
2016-06-29 14:00:44 -04:00
![img ](http://i.imgur.com/iuLpv1c.png )
2016-09-14 19:39:40 -04:00
---
2016-06-29 14:00:44 -04:00
![img ](http://i.imgur.com/V2FWeZx.png )
2016-09-14 19:39:40 -04:00
---
2016-06-29 14:00:44 -04:00
![img ](http://i.imgur.com/BeUtCzF.png )
2016-09-14 19:39:40 -04:00
---
2016-06-29 14:00:44 -04:00
![img ](http://i.imgur.com/phoY7jI.png )
2016-09-14 19:39:40 -04:00
---
2016-06-29 14:00:44 -04:00
![img ](http://i.imgur.com/NvIDgdC.png )
2016-09-14 19:39:40 -04:00
---
2016-06-29 14:00:44 -04:00
![img ](http://i.imgur.com/DzwYyns.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-03-31 15:38:34 -04:00
* [Caravel Google Group ](https://groups.google.com/forum/#!forum/airbnb_caravel )
2016-03-29 00:55:58 -04:00
* [Gitter (live chat) Channel ](https://gitter.im/airbnb/caravel )
2016-04-27 21:12:24 -04:00
* [Docker image 1 ](https://hub.docker.com/r/kochalex/caravel/ )
[Docker image 2 ](https://hub.docker.com/r/amancevice/caravel/ ) (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-03-29 00:55:58 -04:00
Caravel 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-04-01 03:05:12 -04:00
* Much more, check out the `install_requires` section in the [setup.py ](https://github.com/airbnb/caravel/blob/master/setup.py ) file!
2016-02-27 10:47:56 -05:00
Contributing
------------
2016-03-29 00:55:58 -04:00
Interested in contributing? Casual hacking? Check out [Contributing.MD ](https://github.com/airbnb/caravel/blob/master/CONTRIBUTING.md )