pt
/
superset
mirror of https://github.com/apache/superset.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
superset/README.md

135 lines
6.6 KiB
Markdown
Raw Normal View History

Add licenses to translations (#6732) * Add licenses * More licenses * Ignore messages.json as they are generated * More licenses * Also typescript * Fix alignment * Add to svg * Many more licenses * more licenses * Better excludes * Add licenses to docs and md files * Pre-finalize licenses * Fix newlines * Finalize all sourde licenses * Fix lint
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.
-->
[WiP] rename project from Caravel to Superset (#1576) * Change in files * Renamin files and folders * cleaning up a single piece of lint * Removing boat picture from docs * add superset word mark * Update rename note in docs * Fixing images * Pinning datatables * Fixing issues with mapbox-gl * Forgot to rename one file * Linting * v0.13.0 * adding pyyaml to dev-reqs
2016-11-10 02:08:22 -05:00
Superset
Initial commit
2015-07-02 18:16:59 -04:00
=========
[WiP] rename project from Caravel to Superset (#1576) * Change in files * Renamin files and folders * cleaning up a single piece of lint * Removing boat picture from docs * add superset word mark * Update rename note in docs * Fixing images * Pinning datatables * Fixing issues with mapbox-gl * Forgot to rename one file * Linting * v0.13.0 * adding pyyaml to dev-reqs
2016-11-10 02:08:22 -05:00
docs: add and update README badges (#10366)
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)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/apache/incubator-superset)
[docs] use yarn in CONTRIBUTING.md (#3150) * [docs] use yarn in CONTRIBUTING.md * Updating badges
2017-07-19 04:17:56 -04:00
[![Build Status](https://travis-ci.org/apache/incubator-superset.svg?branch=master)](https://travis-ci.org/apache/incubator-superset)
Update another pypi case from superset to apache-superset (#8250)
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)
[coverage] Replacing coveralls with codecov
2018-03-04 15:49:55 -05:00
[![Coverage Status](https://codecov.io/github/apache/incubator-superset/coverage.svg?branch=master)](https://codecov.io/github/apache/incubator-superset)
Fix pypi link and replace gitter badge with slack (#8330)
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)
docs: add and update README badges (#10366)
2020-07-20 17:14:09 -04:00
[![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](https://join.slack.com/t/apache-superset/shared_invite/zt-g8lpruog-HeqpgYrwdfrD5OYhlU7hPQ)
Update docs links on README
2017-06-28 09:23:25 -04:00
[![Documentation](https://img.shields.io/badge/docs-apache.org-blue.svg)](https://superset.incubator.apache.org)
docs: add and update README badges (#10366)
2020-07-20 17:14:09 -04:00
[![Dependencies Status](https://david-dm.org/apache/incubator-superset/status.svg?path=superset-frontend)](https://david-dm.org/apache/incubator-superset?path=superset-frontend)
[WiP] rename project from Caravel to Superset (#1576) * Change in files * Renamin files and folders * cleaning up a single piece of lint * Removing boat picture from docs * add superset word mark * Update rename note in docs * Fixing images * Pinning datatables * Fixing issues with mapbox-gl * Forgot to rename one file * Linting * v0.13.0 * adding pyyaml to dev-reqs
2016-11-10 02:08:22 -05:00
[ui] update logo, favicon, and new primary color (#1781) * update favicon image * change primary color * update logo in header * update logo in readme
2016-12-06 23:59:44 -05:00
<img
src="https://cloud.githubusercontent.com/assets/130878/20946612/49a8a25c-bbc0-11e6-8314-10bef902af51.png"
alt="Superset"
width="500"
/>
Update README.md (#9731) * Update README.md Update and reorganize README to make it easier to navigate and use for community visitors. * Update README.md
2020-05-06 14:55:20 -04:00
A modern, enterprise-ready business intelligence web application.
Refreshing the docs after adding support for SQLA
2015-08-08 11:02:56 -04:00
docs(readme): license info in README is redundant (#10314) Info in in the standard `LICENSE.txt` that GitHub picks up properly and surfaces in the east panel in the main page.
2020-07-14 16:27:02 -04:00
[**Why Superset**](#why-superset) |
Update README.md (#9731) * Update README.md Update and reorganize README to make it easier to navigate and use for community visitors. * Update README.md
2020-05-06 14:55:20 -04:00
[**Database Support**](#database-support) |
[**Installation and Configuration**](#installation-and-configuration) |
[**Get Help**](#get-help) |
[**Contributor Guide**](#contributor-guide) |
[**Resources**](#resources) |
docs(readme): license info in README is redundant (#10314) Info in in the standard `LICENSE.txt` that GitHub picks up properly and surfaces in the east panel in the main page.
2020-07-14 16:27:02 -04:00
[**Superset Users**](INTHEWILD.md)
Adding vid to README.md
2016-01-27 16:56:23 -05:00
Update README.md (#9731) * Update README.md Update and reorganize README to make it easier to navigate and use for community visitors. * Update README.md
2020-05-06 14:55:20 -04:00
## Screenshots & Gifs
Adding vid to README.md
2016-01-27 16:56:23 -05:00
add new screenshots (#1589)
2016-11-17 14:45:40 -05:00
**View Dashboards**
Fix formatting in README.md (#2441)
2017-03-21 17:00:09 -04:00
SIP-32: Moving frontend code to the base of the repo (#9098) * move assets out, get webpack dev working * update docs to reference superset-frontend * draw the rest of the owl * fix docs * fix webpack script * rats * correct docs * fix tox dox
2020-02-09 20:53:56 -05:00
<kbd><img title="View Dashboards" src="https://raw.githubusercontent.com/apache/incubator-superset/master/superset-frontend/images/screenshots/bank_dash.png"></kbd><br/>
Animated GIFs on README (#1109)
2016-09-14 19:39:40 -04:00
Update README with fresher screenshots (#4825) * Improve screenshots in README.md * Add border to images * Add visualizations.png
2018-04-14 18:32:26 -04:00
**Slice & dice your data**
Fix formatting in README.md (#2441)
2017-03-21 17:00:09 -04:00
SIP-32: Moving frontend code to the base of the repo (#9098) * move assets out, get webpack dev working * update docs to reference superset-frontend * draw the rest of the owl * fix docs * fix webpack script * rats * correct docs * fix tox dox
2020-02-09 20:53:56 -05:00
<kbd><img title="Slice & dice your data" src="https://raw.githubusercontent.com/apache/incubator-superset/master/superset-frontend/images/screenshots/explore.png"></kbd><br/>
Fix formatting in README.md (#2441)
2017-03-21 17:00:09 -04:00
Update README with fresher screenshots (#4825) * Improve screenshots in README.md * Add border to images * Add visualizations.png
2018-04-14 18:32:26 -04:00
**Query and visualize your data with SQL Lab**
Animated GIFs on README (#1109)
2016-09-14 19:39:40 -04:00
SIP-32: Moving frontend code to the base of the repo (#9098) * move assets out, get webpack dev working * update docs to reference superset-frontend * draw the rest of the owl * fix docs * fix webpack script * rats * correct docs * fix tox dox
2020-02-09 20:53:56 -05:00
<kbd><img title="SQL Lab" src="https://raw.githubusercontent.com/apache/incubator-superset/master/superset-frontend/images/screenshots/sqllab.png"></kbd><br/>
Fix formatting in README.md (#2441)
2017-03-21 17:00:09 -04:00
Update README with fresher screenshots (#4825) * Improve screenshots in README.md * Add border to images * Add visualizations.png
2018-04-14 18:32:26 -04:00
**Visualize geospatial data with deck.gl**
Fix formatting in README.md (#2441)
2017-03-21 17:00:09 -04:00
SIP-32: Moving frontend code to the base of the repo (#9098) * move assets out, get webpack dev working * update docs to reference superset-frontend * draw the rest of the owl * fix docs * fix webpack script * rats * correct docs * fix tox dox
2020-02-09 20:53:56 -05:00
<kbd><img title="Geospatial" src="https://raw.githubusercontent.com/apache/incubator-superset/master/superset-frontend/images/screenshots/deckgl_dash.png"></kbd><br/>
Animated GIFs on README (#1109)
2016-09-14 19:39:40 -04:00
Update README with fresher screenshots (#4825) * Improve screenshots in README.md * Add border to images * Add visualizations.png
2018-04-14 18:32:26 -04:00
**Choose from a wide array of visualizations**
Fix formatting in README.md (#2441)
2017-03-21 17:00:09 -04:00
SIP-32: Moving frontend code to the base of the repo (#9098) * move assets out, get webpack dev working * update docs to reference superset-frontend * draw the rest of the owl * fix docs * fix webpack script * rats * correct docs * fix tox dox
2020-02-09 20:53:56 -05:00
<kbd><img title="Visualizations" src="https://raw.githubusercontent.com/apache/incubator-superset/master/superset-frontend/images/screenshots/visualizations.png"></kbd><br/>
Bugfixes+ better docs
2015-09-21 16:48:02 -04:00
Update README.md (#9731) * Update README.md Update and reorganize README to make it easier to navigate and use for community visitors. * Update README.md
2020-05-06 14:55:20 -04:00
## Why Superset
Bugfixes+ better docs
2015-09-21 16:48:02 -04:00
[WiP] rename project from Caravel to Superset (#1576) * Change in files * Renamin files and folders * cleaning up a single piece of lint * Removing boat picture from docs * add superset word mark * Update rename note in docs * Fixing images * Pinning datatables * Fixing issues with mapbox-gl * Forgot to rename one file * Linting * v0.13.0 * adding pyyaml to dev-reqs
2016-11-10 02:08:22 -05:00
Superset provides:
Imporving the README
2017-06-17 02:31:50 -04:00
* 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
Fixed two typos in the README (#9305) I noticed two small typos in the README that I fixed: 1) "Acts" was wrong because it does not have the correct subject-verb agreement 2) "Who Have" is the wrong pronoun to use when referring to companies. "That have" is the grammatically correct option. Additionally, my company, Let's Roam, uses superset to visualize people completing challenges all over the world.
2020-03-14 16:38:09 -04:00
underlying exposed dashboards. The dashboards and charts act as a starting
Imporving the README
2017-06-17 02:31:50 -04:00
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.
Bugfixes+ better docs
2015-09-21 16:48:02 -04:00
* An extensible, high granularity security model allowing intricate rules
Imporving the README
2017-06-17 02:31:50 -04:00
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
[WiP] rename project from Caravel to Superset (#1576) * Change in files * Renamin files and folders * cleaning up a single piece of lint * Removing boat picture from docs * add superset word mark * Update rename note in docs * Fixing images * Pinning datatables * Fixing issues with mapbox-gl * Forgot to rename one file * Linting * v0.13.0 * adding pyyaml to dev-reqs
2016-11-10 02:08:22 -05:00
* Deep integration with Druid allows for Superset to stay blazing fast while
Bugfixes+ better docs
2015-09-21 16:48:02 -04:00
slicing and dicing large, realtime datasets
Cranking up FAB to latest (1.7.1) version (#609)
2016-06-13 12:25:22 -04:00
* Fast loading dashboards with configurable caching
Bugfixes+ better docs
2015-09-21 16:48:02 -04:00
Update README.md (#9731) * Update README.md Update and reorganize README to make it easier to navigate and use for community visitors. * Update README.md
2020-05-06 14:55:20 -04:00
## Database Support
Refreshing the docs after adding support for SQLA
2015-08-08 11:02:56 -04:00
docs: remove focus on Druid in README.md (#9184) The text in the README seemed overly Druid-centric at this time. While originally (3-4 years ago) Superset was heavily focussed on druid, it's just not accurate anymore. Druid is just one of the databases that we support and docs should reflect that.
2020-02-24 05:30:25 -05:00
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
Update index.rst (#7672)
2019-06-11 12:46:27 -04:00
[here](https://superset.incubator.apache.org/#databases).
Imporving the README
2017-06-17 02:31:50 -04:00
Adding installation infromation in README.md
2015-07-22 11:53:38 -04:00
Update README.md (#9731) * Update README.md Update and reorganize README to make it easier to navigate and use for community visitors. * Update README.md
2020-05-06 14:55:20 -04:00
## Installation and Configuration
Preparing pypi package
2015-09-05 12:23:46 -04:00
Update docs links on README
2017-06-28 09:23:25 -04:00
[See in the documentation](https://superset.incubator.apache.org/installation.html)
Preparing pypi package
2015-09-05 12:23:46 -04:00
docs(readme): move Slack guidelines to CODE_OF_CONDUCT (#10315) The Slack community guidelines are kind of wordy and best belong as part of our code of conduct. Let's make `README.md` super streamlined, and link out to resources like this one.
2020-07-15 18:21:20 -04:00
## Get Involved
docs: added slack community guidelines (#10209) * refactor: added slack community guidelines * Some tweaks! * busting cache to pass tests! * Implemented excellent feedback
2020-06-30 23:20:09 -04:00
docs(readme): move Slack guidelines to CODE_OF_CONDUCT (#10315) The Slack community guidelines are kind of wordy and best belong as part of our code of conduct. Let's make `README.md` super streamlined, and link out to resources like this one.
2020-07-15 18:21:20 -04:00
* Ask and answer questions on [StackOverflow](https://stackoverflow.com/questions/tagged/apache-superset)
fix: update community Slack link (#10360)
2020-07-17 17:10:50 -04:00
* [Join our community's Slack](https://join.slack.com/t/apache-superset/shared_invite/zt-g8lpruog-HeqpgYrwdfrD5OYhlU7hPQ)
docs(readme): move Slack guidelines to CODE_OF_CONDUCT (#10315) The Slack community guidelines are kind of wordy and best belong as part of our code of conduct. Let's make `README.md` super streamlined, and link out to resources like this one.
2020-07-15 18:21:20 -04:00
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)
docs: added slack community guidelines (#10209) * refactor: added slack community guidelines * Some tweaks! * busting cache to pass tests! * Implemented excellent feedback
2020-06-30 23:20:09 -04:00
Adding a link section to readme
2015-12-11 11:51:13 -05:00
Update README.md (#9731) * Update README.md Update and reorganize README to make it easier to navigate and use for community visitors. * Update README.md
2020-05-06 14:55:20 -04:00
## Contributor Guide
Ripping highcharts out
2015-09-27 21:02:00 -04:00
docs(readme): move Slack guidelines to CODE_OF_CONDUCT (#10315) The Slack community guidelines are kind of wordy and best belong as part of our code of conduct. Let's make `README.md` super streamlined, and link out to resources like this one.
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.
Moving content of assets/readme.md to contributing.md
2016-02-27 10:47:56 -05:00
Imporving the README
2017-06-17 02:31:50 -04:00
Update README.md (#9731) * Update README.md Update and reorganize README to make it easier to navigate and use for community visitors. * Update README.md
2020-05-06 14:55:20 -04:00
## Resources
Imporving the README
2017-06-17 02:31:50 -04:00
Break down Superset 101 Getting Started content (#10138) Break down Superset 101 Getting Started content, so it's directly linked to the relevant blog post and more user-friendly.
2020-06-22 22:34:41 -04:00
* 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/)
Update README.md (#10221) Adding new tutorial blog on Time Series Charts to the Resources Section
2020-07-01 22:36:11 -04:00
* [Create Time Series Charts](https://preset.io/blog/2020-06-26-timeseries-chart/)
Update README.md (#9731) * Update README.md Update and reorganize README to make it easier to navigate and use for community visitors. * Update README.md
2020-05-06 14:55:20 -04:00
* [Docker image](https://hub.docker.com/r/preset/superset/)
Update README Resources section (#9864) Update to README Resources section with May 2020 virtual meetup recording and link to Youtube channel
2020-05-21 12:35:13 -04:00
* [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)
docs: pointers to plugins blog post (#10251) * docs: pointers to plugins blog post * fix build
2020-07-28 01:46:37 -04:00
* [So, You Want to Build a Superset Viz Plugin...](https://preset.io/blog/2020-07-02-hello-world/)