2019-01-22 11:21:13 -05:00
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
2020-10-05 01:01:36 -04:00
2021-04-29 01:17:21 -04:00
# Superset
2016-11-10 02:08:22 -05:00
2020-07-20 17:14:09 -04:00
[![License ](https://img.shields.io/badge/License-Apache%202.0-blue.svg )](https://opensource.org/licenses/Apache-2.0)
2021-03-12 16:02:09 -05:00
[![GitHub release (latest SemVer) ](https://img.shields.io/github/v/release/apache/superset?sort=semver )](https://github.com/apache/superset/tree/latest)
2021-01-06 06:45:19 -05:00
[![Build Status ](https://github.com/apache/superset/workflows/Python/badge.svg )](https://github.com/apache/superset/actions)
2019-09-18 19:36:08 -04:00
[![PyPI version ](https://badge.fury.io/py/apache-superset.svg )](https://badge.fury.io/py/apache-superset)
2021-01-06 06:45:19 -05:00
[![Coverage Status ](https://codecov.io/github/apache/superset/coverage.svg?branch=master )](https://codecov.io/github/apache/superset)
2019-10-06 17:06:51 -04:00
[![PyPI ](https://img.shields.io/pypi/pyversions/apache-superset.svg?maxAge=2592000 )](https://pypi.python.org/pypi/apache-superset)
2021-08-26 09:04:51 -04:00
[![Get on Slack ](https://img.shields.io/badge/slack-join-orange.svg )](https://join.slack.com/t/apache-superset/shared_invite/zt-uxbh5g36-AISUtHbzOXcu0BIj7kgUaw)
2020-09-16 12:56:56 -04:00
[![Documentation ](https://img.shields.io/badge/docs-apache.org-blue.svg )](https://superset.apache.org)
2021-01-06 06:45:19 -05:00
[![Dependencies Status ](https://david-dm.org/apache/superset/status.svg?path=superset-frontend )](https://david-dm.org/apache/superset?path=superset-frontend)
2016-11-10 02:08:22 -05:00
2016-12-06 23:59:44 -05:00
< img
2021-04-29 01:17:21 -04:00
src="https://github.com/apache/superset/raw/master/superset-frontend/src/assets/branding/superset-logo-horiz-apache.png"
2016-12-06 23:59:44 -05:00
alt="Superset"
width="500"
/>
2020-05-06 14:55:20 -04:00
A modern, enterprise-ready business intelligence web application.
2015-08-08 11:02:56 -04:00
2021-01-20 19:27:19 -05:00
[**Why Superset?** ](#why-superset ) |
2020-08-03 16:50:52 -04:00
[**Supported Databases** ](#supported-databases ) |
2020-05-06 14:55:20 -04:00
[**Installation and Configuration** ](#installation-and-configuration ) |
2021-01-20 21:18:21 -05:00
[**Release Notes** ](RELEASING/README.md#release-notes-for-recent-releases ) |
2021-01-20 19:27:19 -05:00
[**Get Involved** ](#get-involved ) |
2020-05-06 14:55:20 -04:00
[**Contributor Guide** ](#contributor-guide ) |
[**Resources** ](#resources ) |
2021-03-16 17:11:17 -04:00
[**Organizations Using Superset** ](RESOURCES/INTHEWILD.md )
2016-01-27 16:56:23 -05:00
2020-05-06 14:55:20 -04:00
## Screenshots & Gifs
2016-01-27 16:56:23 -05:00
2020-09-22 01:48:55 -04:00
**Gallery**
2021-03-12 16:02:09 -05:00
< kbd > < a href = "https://superset.apache.org/gallery" > < img title = "Gallery" src = "superset-frontend/images/screenshots/gallery.jpg" / > < / a > < / kbd > < br / >
2020-09-22 01:48:55 -04:00
2016-11-17 14:45:40 -05:00
**View Dashboards**
2017-03-21 17:00:09 -04:00
2021-03-12 16:02:09 -05:00
< kbd > < img title = "View Dashboards" src = "superset-frontend/images/screenshots/slack_dash.jpg" / > < / kbd > < br / >
2016-09-14 19:39:40 -04:00
2018-04-14 18:32:26 -04:00
**Slice & dice your data**
2017-03-21 17:00:09 -04:00
2021-03-12 16:02:09 -05:00
< kbd > < img title = "Slice & dice your data" src = "superset-frontend/images/screenshots/explore.jpg" / > < / kbd > < br / >
2017-03-21 17:00:09 -04:00
2018-04-14 18:32:26 -04:00
**Query and visualize your data with SQL Lab**
2016-09-14 19:39:40 -04:00
2021-03-12 16:02:09 -05:00
< kbd > < img title = "SQL Lab" src = "superset-frontend/images/screenshots/sql_lab.jpg" / > < / kbd > < br / >
2017-03-21 17:00:09 -04:00
2018-04-14 18:32:26 -04:00
**Visualize geospatial data with deck.gl**
2017-03-21 17:00:09 -04:00
2021-03-12 16:02:09 -05:00
< kbd > < img title = "Geospatial" src = "superset-frontend/images/screenshots/geospatial_dash.jpg" / > < / kbd > < br / >
2016-09-14 19:39:40 -04:00
2018-04-14 18:32:26 -04:00
**Choose from a wide array of visualizations**
2017-03-21 17:00:09 -04:00
2021-03-12 16:02:09 -05:00
< kbd > < img title = "Visualizations" src = "superset-frontend/images/screenshots/explore_visualizations.jpg" / > < / kbd > < br / >
2015-09-21 16:48:02 -04:00
2021-01-20 19:27:19 -05:00
## Why Superset?
2015-09-21 16:48:02 -04:00
2016-11-10 02:08:22 -05:00
Superset provides:
2015-09-21 16:48:02 -04:00
2021-04-29 01:17:21 -04:00
- An intuitive interface for visualizing datasets and
crafting interactive dashboards
- A wide array of beautiful visualizations to showcase your data
- Code-free visualization builder to extract and present datasets
- A world-class SQL IDE for preparing data for visualization, including a rich metadata browser
- A lightweight semantic layer which empowers data analysts to quickly define custom dimensions and metrics
- Out-of-the-box support for most SQL-speaking databases
- Seamless, in-memory asynchronous caching and queries
- An extensible security model that allows configuration of very intricate rules
on who can access which product features and datasets.
- Integration with major
authentication backends (database, OpenID, LDAP, OAuth, REMOTE_USER, etc)
- The ability to add custom visualization plugins
- An API for programmatic customization
- A cloud-native architecture designed from the ground up for scale
2015-09-21 16:48:02 -04:00
2020-08-03 16:50:52 -04:00
## Supported Databases
2015-08-08 11:02:56 -04:00
2021-01-20 19:27:19 -05:00
Superset can query data from any SQL-speaking datastore or data engine (e.g. Presto or Athena) that has a Python DB-API driver and a SQLAlchemy dialect.
Here are some of the major database solutions that are supported:
2020-08-03 16:50:52 -04:00
< p align = "center" >
2021-02-23 14:32:21 -05:00
< img src = "superset-frontend/images/redshift.png" alt = "redshift" border = "0" width = "106" height = "41" / >
< img src = "superset-frontend/images/google-biquery.png" alt = "google-biquery" border = "0" width = "114" height = "43" / >
< img src = "superset-frontend/images/snowflake.png" alt = "snowflake" border = "0" width = "152" height = "46" / >
< img src = "superset-frontend/images/trino.png" alt = "trino" border = "0" width = "46" height = "46" / >
< img src = "superset-frontend/images/presto.png" alt = "presto" border = "0" width = "152" height = "46" / >
< img src = "superset-frontend/images/druid.png" alt = "druid" border = "0" width = "135" height = "37" / >
< img src = "superset-frontend/images/postgresql.png" alt = "postgresql" border = "0" width = "132" height = "81" / >
< img src = "superset-frontend/images/mysql.png" alt = "mysql" border = "0" width = "119" height = "62" / >
< img src = "superset-frontend/images/mssql-server.png" alt = "mssql-server" border = "0" width = "93" height = "74" / >
< img src = "superset-frontend/images/db2.png" alt = "db2" border = "0" width = "62" height = "62" / >
< img src = "superset-frontend/images/sqlite.png" alt = "sqlite" border = "0" width = "102" height = "45" / >
< img src = "superset-frontend/images/sybase.png" alt = "sybase" border = "0" width = "128" height = "47" / >
< img src = "superset-frontend/images/mariadb.png" alt = "mariadb" border = "0" width = "83" height = "63" / >
< img src = "superset-frontend/images/vertica.png" alt = "vertica" border = "0" width = "128" height = "40" / >
< img src = "superset-frontend/images/oracle.png" alt = "oracle" border = "0" width = "121" height = "66" / >
< img src = "superset-frontend/images/firebird.png" alt = "firebird" border = "0" width = "86" height = "56" / >
< img src = "superset-frontend/images/greenplum.png" alt = "greenplum" border = "0" width = "140" height = "45" / >
< img src = "superset-frontend/images/clickhouse.png" alt = "clickhouse" border = "0" width = "133" height = "34" / >
< img src = "superset-frontend/images/exasol.png" alt = "exasol" border = "0" width = "106" height = "59" / >
< img src = "superset-frontend/images/monet-db.png" alt = "monet-db" border = "0" width = "106" height = "46" / >
< img src = "superset-frontend/images/apache-kylin.png" alt = "apache-kylin" border = "0" width = "56" height = "64" / >
2021-01-28 19:36:06 -05:00
< img src = "superset-frontend/images/hologres.png" alt = "hologres" border = "0" width = "71" height = "64" / >
2021-06-30 10:58:33 -04:00
< img src = "superset-frontend/images/netezza.png" alt = "netezza" border = "0" width = "64" height = "64" / >
2020-08-03 16:50:52 -04:00
< / p >
2021-01-20 19:27:19 -05:00
**A more comprehensive list of supported databases** along with the configuration instructions can be found
2021-01-06 06:45:19 -05:00
[here ](https://superset.apache.org/docs/databases/installing-database-drivers ).
2017-06-17 02:31:50 -04:00
2021-01-20 19:27:19 -05:00
Want to add support for your datastore or data engine? Read more [here ](https://superset.apache.org/docs/frequently-asked-questions#does-superset-work-with-insert-database-engine-here ) about the technical requirements.
2020-05-06 14:55:20 -04:00
## Installation and Configuration
2015-09-05 12:23:46 -04:00
2021-01-20 19:27:19 -05:00
[Extended documentation for Superset ](https://superset.apache.org/docs/installation/installing-superset-using-docker-compose )
2015-09-05 12:23:46 -04:00
2020-07-15 18:21:20 -04:00
## Get Involved
2020-06-30 23:20:09 -04:00
2021-04-29 01:17:21 -04:00
- Ask and answer questions on [StackOverflow ](https://stackoverflow.com/questions/tagged/apache-superset ) using the **apache-superset** tag
2021-08-26 09:04:51 -04:00
- [Join our community's Slack ](https://join.slack.com/t/apache-superset/shared_invite/zt-uxbh5g36-AISUtHbzOXcu0BIj7kgUaw )
2021-03-16 17:11:17 -04:00
and please read our [Slack Community Guidelines ](https://github.com/apache/superset/blob/master/CODE_OF_CONDUCT.md#slack-community-guidelines )
2021-04-29 01:17:21 -04:00
- [Join our dev@superset.apache.org Mailing list ](https://lists.apache.org/list.html?dev@superset.apache.org )
2015-12-11 11:51:13 -05:00
2020-05-06 14:55:20 -04:00
## Contributor Guide
2015-09-27 21:02:00 -04:00
2020-07-15 18:21:20 -04:00
Interested in contributing? Check out our
[CONTRIBUTING.md ](https://github.com/apache/superset/blob/master/CONTRIBUTING.md )
to find resources around contributing along with a detailed guide on
how to set up a development environment.
2016-02-27 10:47:56 -05:00
2021-09-28 09:53:14 -04:00
## Installation Steps for Superset+Firebolt SQLAlchemy Adapter
### Pre-requisites
1. Git - https://www.atlassian.com/git/tutorials/install-git
2. Docker - https://docs.docker.com/engine/install/
3. Python3
### Firebolt SQLAlchemy installation steps
````bash
# 1. In your terminal, run below commands to clone superset and switch to firebolt-integration branch
$ cd $HOME
$ git clone https://github.com/raghavSharmaSigmoid/superset.git
$ cd superset
$ git checkout firebolt-integration
2021-09-29 07:27:53 -04:00
# 2. Run below commands to create local requirements text file which has firebolt adapter path
2021-09-28 09:53:14 -04:00
$ touch ./docker/requirements-local.txt
2021-09-29 07:27:53 -04:00
$ echo "firebolt-sqlalchemy" >> ./docker/requirements-local.txt
2021-09-28 09:53:14 -04:00
2021-09-29 07:27:53 -04:00
# 3. Run below command to build and start docker
$ docker-compose build --force-rm
2021-09-28 09:53:14 -04:00
$ docker-compose up
````
2020-05-06 14:55:20 -04:00
## Resources
2017-06-17 02:31:50 -04:00
2021-04-29 01:17:21 -04:00
- Superset 1.0
- [Superset 1.0 Milestone ](https://superset.apache.org/docs/version-one )
- [Superset 1.0 Release Notes ](https://github.com/apache/superset/tree/master/RELEASING/release-notes-1-0 )
2021-04-30 11:59:08 -04:00
- Getting Started with Superset
- [Superset in 2 Minutes using Docker Compose ](https://superset.apache.org/docs/installation/installing-superset-using-docker-compose#installing-superset-locally-using-docker-compose )
- [Installing Database Drivers ](https://superset.apache.org/docs/databases/dockeradddrivers )
- [Building New Database Connectors ](https://preset.io/blog/building-database-connector/ )
- [Create Your First Dashboard ](https://superset.apache.org/docs/creating-charts-dashboards/first-dashboard )
- [Documentation for Superset End-Users (by Preset) ](https://docs.preset.io/docs/terminology )
- Deploying Superset
- [Official Docker image ](https://hub.docker.com/r/apache/superset )
- [Helm Chart ](https://github.com/apache/superset/tree/master/helm/superset )
- [Recordings of Past Community Events ](https://www.youtube.com/channel/UCMuwrvBsg_jjI2gLcm04R0g )
- [Meetup: Superset 1.0 ](https://www.youtube.com/watch?v=gEZkFF2kokk )
- [Live Demo: Interactive Time-series Analysis with Druid and Superset ](https://www.youtube.com/watch?v=4eh7OTfMln8 )
- [Live Demo: Visualizing MongoDB and Pinot Data using Trino ](https://www.youtube.com/watch?v=Dw_al_26F6o )
- Upcoming Superset Events
- [Superset + Star Wars: May the 4th Be With You ](https://preset.io/events/2021-05-04-superset-star-wars-may-the-4th-be-with-you )
- [Meetup - Developing and Deploying Custom Visualization Plugins in Superset ](https://www.meetup.com/Global-Apache-Superset-Community-Meetup/events/277835486/ )
- [Visualize Your Data Lake Using Athena and Superset ](https://preset.io/events/2021-05-18-visualize-your-data-lake-using-athena-and-superset )
- Visualizations
2021-04-29 01:17:21 -04:00
- [Building Custom Viz Plugins ](https://superset.apache.org/docs/installation/building-custom-viz-plugins )
- [Managing and Deploying Custom Viz Plugins ](https://medium.com/nmc-techblog/apache-superset-manage-custom-viz-plugins-in-production-9fde1a708e55 )
2021-04-30 11:59:08 -04:00
- [Why Apache Superset is Betting on Apache ECharts ](https://preset.io/blog/2021-4-1-why-echarts/ )
2021-04-29 01:17:21 -04:00
- [Superset API ](https://superset.apache.org/docs/rest-api )