For every star on GitHub, we'll donate $2 to clean up our waterways. Star us now!
Once you have your data cleaned up and ready for consumption, Meltano lets you easily install and configure best in class open source business intelligence tools like Superset.
The Superset plugin requires Meltano version 2.0. If you’re on an older version, make sure you update Meltano first.
Change directories so that you are inside your Meltano project,
and then run the following command to add Superset
to your project and make it available to use via
meltano add utility superset
Once you have Meltano running, you likely already have everything you need for Superset as well. If you do run into trouble installing Superset following the instructions below, check out the OS Dependencies section in the Superset documentation. Note that the rest of that guide is not relevant if you’re using Meltano to manage your Superset installation, initialization, and configuration.
Superset does not ship bundled with connectivity to databases, except for SQLite, which is part of the Python standard library. You’ll need to install the required packages for the database you want to use as your metadata database as well as the packages needed to connect to the databases you want to access through Superset.
You can find the list of supported databases and the appropriate PyPI (pip) packages in the Supported Databases and Dependencies section in the Superset documentation.
These can then be added to your Meltano project by configuring a custom
pip_url for the
superset plugin definition in your
meltano.yml project file
pip_urlproperty to include the desired additional packages:
utilities: - name: superset variant: apache pip_url: apache-superset==1.5.0 snowflake-sqlalchemy
meltano install utility superset
If you’re running Superset for the first time in a new environment, generate a new SECRET_KEY to increase security:
meltano config superset set SECRET_KEY $(openssl rand -base64 42)
Create an admin user to allow you to log into the UI:
meltano invoke superset:create-admin # This is equivalent to `superset fab create-admin` in the Superset documentation
Optionally, load some example data to play with:
meltano invoke superset:load-examples # This is equivalent to `superset load_examples` in the Superset documentation
For more details and a full list of settings, see the Superset plugin page on MeltanoHub.
Now that Superset is installed you’ve optionally set custom configurations, let’s start the UI:
meltano invoke superset:ui
Superset will start up and by default be available at http://localhost:8088 in your browser and the backend database will be saved in
Once you have the Superset UI up and running the next steps are: