README.md 6.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<!--
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.
-->
19
Superset
M
Maxime 已提交
20
=========
21

22 23
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/apache/incubator-superset)
24
[![Build Status](https://travis-ci.org/apache/incubator-superset.svg?branch=master)](https://travis-ci.org/apache/incubator-superset)
25
[![PyPI version](https://badge.fury.io/py/apache-superset.svg)](https://badge.fury.io/py/apache-superset)
26
[![Coverage Status](https://codecov.io/github/apache/incubator-superset/coverage.svg?branch=master)](https://codecov.io/github/apache/incubator-superset)
27
[![PyPI](https://img.shields.io/pypi/pyversions/apache-superset.svg?maxAge=2592000)](https://pypi.python.org/pypi/apache-superset)
28
[![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](https://join.slack.com/t/apache-superset/shared_invite/zt-g8lpruog-HeqpgYrwdfrD5OYhlU7hPQ)
M
Maxime Beauchemin 已提交
29
[![Documentation](https://img.shields.io/badge/docs-apache.org-blue.svg)](https://superset.incubator.apache.org)
30
[![Dependencies Status](https://david-dm.org/apache/incubator-superset/status.svg?path=superset-frontend)](https://david-dm.org/apache/incubator-superset?path=superset-frontend)
31

32 33 34 35 36 37
<img
  src="https://cloud.githubusercontent.com/assets/130878/20946612/49a8a25c-bbc0-11e6-8314-10bef902af51.png"
  alt="Superset"
  width="500"
/>

K
kxu 已提交
38
A modern, enterprise-ready business intelligence web application.
39

40
[**Why Superset**](#why-superset) |
K
kxu 已提交
41 42 43 44 45
[**Database Support**](#database-support) |
[**Installation and Configuration**](#installation-and-configuration) |
[**Get Help**](#get-help) |
[**Contributor Guide**](#contributor-guide) |
[**Resources**](#resources) |
46
[**Superset Users**](INTHEWILD.md)
M
Maxime Beauchemin 已提交
47

K
kxu 已提交
48 49

## Screenshots & Gifs
M
Maxime Beauchemin 已提交
50

A
Alanna Scott 已提交
51
**View Dashboards**
52

53
<kbd><img title="View Dashboards" src="https://raw.githubusercontent.com/apache/incubator-superset/master/superset-frontend/images/screenshots/bank_dash.png"></kbd><br/>
54

55
**Slice & dice your data**
56

57
<kbd><img title="Slice & dice your data" src="https://raw.githubusercontent.com/apache/incubator-superset/master/superset-frontend/images/screenshots/explore.png"></kbd><br/>
58

59
**Query and visualize your data with SQL Lab**
60

61
<kbd><img title="SQL Lab" src="https://raw.githubusercontent.com/apache/incubator-superset/master/superset-frontend/images/screenshots/sqllab.png"></kbd><br/>
62

63
**Visualize geospatial data with deck.gl**
64

65
<kbd><img title="Geospatial" src="https://raw.githubusercontent.com/apache/incubator-superset/master/superset-frontend/images/screenshots/deckgl_dash.png"></kbd><br/>
66

67
**Choose from a wide array of visualizations**
68

69
<kbd><img title="Visualizations" src="https://raw.githubusercontent.com/apache/incubator-superset/master/superset-frontend/images/screenshots/visualizations.png"></kbd><br/>
M
Maxime Beauchemin 已提交
70

K
kxu 已提交
71
## Why Superset
M
Maxime Beauchemin 已提交
72

73
Superset provides:
M
Maxime Beauchemin 已提交
74 75 76 77
* An intuitive interface to explore and visualize datasets, and
    create interactive dashboards.
* A wide array of beautiful visualizations to showcase your data.
* Easy, code-free, user flows to drill down and slice and dice the data
78
    underlying exposed dashboards. The dashboards and charts act as a starting
M
Maxime Beauchemin 已提交
79 80 81
    point for deeper analysis.
* A state of the art SQL editor/IDE exposing a rich metadata browser, and
    an easy workflow to create visualizations out of any result set.
M
Maxime Beauchemin 已提交
82
* An extensible, high granularity security model allowing intricate rules
M
Maxime Beauchemin 已提交
83 84 85 86 87 88
    on who can access which product features and datasets.
    Integration with major
    authentication backends (database, OpenID, LDAP, OAuth, REMOTE_USER, ...)
* A lightweight semantic layer, allowing to control how data sources are
    exposed to the user by defining dimensions and metrics
* Out of the box support for most SQL-speaking databases
89
* Deep integration with Druid allows for Superset to stay blazing fast while
M
Maxime Beauchemin 已提交
90
    slicing and dicing large, realtime datasets
91
* Fast loading dashboards with configurable caching
M
Maxime Beauchemin 已提交
92 93


K
kxu 已提交
94
## Database Support
95

96 97 98
Superset speaks many SQL dialects through SQLAlchemy - a Python
SQL toolkit that is compatible with most databases. A list of
supported databases can be found
J
John Bodley 已提交
99
[here](https://superset.incubator.apache.org/#databases).
M
Maxime Beauchemin 已提交
100

101

K
kxu 已提交
102
## Installation and Configuration
M
Maxime Beauchemin 已提交
103

M
Maxime Beauchemin 已提交
104
[See in the documentation](https://superset.incubator.apache.org/installation.html)
M
Maxime Beauchemin 已提交
105 106


107
## Get Involved
108

109
* Ask and answer questions on [StackOverflow](https://stackoverflow.com/questions/tagged/apache-superset)
K
kxu 已提交
110
* [Join our community's Slack](https://join.slack.com/t/apache-superset/shared_invite/zt-g8lpruog-HeqpgYrwdfrD5OYhlU7hPQ)
111 112
  and please read our [Slack Community Guidelines](CODE_OF_CONDUCT.md#slack-community-guidelines)
* [Join our dev@superset.apache.org Mailing list](https://lists.apache.org/list.html?dev@superset.apache.org)
113

114

K
kxu 已提交
115
## Contributor Guide
M
Maxime Beauchemin 已提交
116

117 118 119 120
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.
121

M
Maxime Beauchemin 已提交
122

K
kxu 已提交
123
## Resources
M
Maxime Beauchemin 已提交
124

125 126 127 128 129
* Superset 101 -- Getting Started Guide (From [Preset](https://preset.io) [Blog](https://preset.io/blog/))
  * [Installing Apache Superset Locally](https://preset.io/blog/2020-05-11-getting-started-installing-superset/)
  * [Installing Database Drivers](https://preset.io/blog/2020-05-18-install-db-drivers/)
  * [Connect Superset To Google Sheets](https://preset.io/blog/2020-06-01-connect-superset-google-sheets/)
  * [Create Your First Chart](https://preset.io/blog/2020-06-08-first-chart/)
K
kxu 已提交
130
  * [Create Time Series Charts](https://preset.io/blog/2020-06-26-timeseries-chart/)
K
kxu 已提交
131
* [Docker image](https://hub.docker.com/r/preset/superset/)
K
kxu 已提交
132 133
* [Youtube Channel](https://www.youtube.com/channel/UCMuwrvBsg_jjI2gLcm04R0g)
  * [May 15, 2020: Virtual Meetup Recording. Topics: 0.36 Overview, Committers Self-Intro, Roadmap](https://www.youtube.com/watch?v=tXGDmqjmcTs&t=20s)
134
* [So, You Want to Build a Superset Viz Plugin...](https://preset.io/blog/2020-07-02-hello-world/)