From 45c5072649a7926fc4d15d2eb0b9cc5a89e5d7b2 Mon Sep 17 00:00:00 2001 From: apurva-sigmoid <89530372+apurva-sigmoid@users.noreply.github.com> Date: Tue, 28 Sep 2021 19:23:14 +0530 Subject: [PATCH] Updated README.md Added steps to install and run Superset with Firebolt SQLAlchemy Adapter --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index 443c48c6aabab..403c2f1bb93e4 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,40 @@ Interested in contributing? Check out our to find resources around contributing along with a detailed guide on how to set up a development environment. +## 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 + +# 2. Run below commands to clone firebolt adapter into superset folder +$ cd superset +$ git clone https://github.com/raghavSharmaSigmoid/firebolt-sqlalchemy.git + +# 3. Run below commands to build the firebolt adapter +$ cd firebolt-sqlalchemy +$ python3 -m build + +# 4. Run below commands to create local requirements text file which has firebolt adapter path +$ cd $HOME/superset +$ touch ./docker/requirements-local.txt +$ echo "firebolt-sqlalchemy@file://localhost/app/superset/firebolt-sqlalchemy/dist/firebolt-sqlalchemy-0.0.1.tar.gz#egg=firebolt-sqlalchemy" >> ./docker/requirements-local.txt + +# 5. Run below command to start docker +$ docker-compose up +```` + ## Resources - Superset 1.0