Setting Up your Tutorial Environment

In this step you will setup the environment needed for running the tutorial and using Elementary.

Before you start:

Prerequisites

For the tutorial you will need:

A working Python installation
pip installer for Python
Access and credentials to a data warehouse supported by Elementary

We also recommend you work with a Python virtual environment.

Setting Up Your Tutorial Project:

1. Initialize a New dbt Project:

Name the project elementary_tutorial

dbt init elementary_tutorial

Ensure that you have a working connection to your DWH. To troubleshoot, you can run dbt debug.

2. Add Sample Data to your Tutorial Project

We created a dbt project to help us with the tutorial. The project is an extended version of the dbt “jaffle shop” project. It contains seeds and models that we will use to run Elementary’s tests on, and collect arrtifacts.

In order to load the tutorial project into your dbt project download the files here.

seeds: copy the validation and training folders from the seeds directory into your local project’s seeds folder.
models: copy all of the files plus the staging folder into the models folder in your local dbt project.

3. Seed Data to our DWH

We will populate our DWH with the sample data:

dbt seed

1. Fork the Elementary Tutorial Repo

We created a dbt project to help us with the tutorial. The project is an extended version of the dbt jaffle shop project. It contains seeds and models that we will use to run Elementary’s tests on, and collect artifacts.

In order to load the tutorial project into your dbt cloud environment, you need to fork the repo and connect a new project to it.

To fork the the tutorial repo, go to the tutorial repo and click on the fork button.

2. Create a new dbt Project

To create a new project in dbt cloud, go to Account Settings and click on the New Project button under the Projects section.
Create a new project named elementary_tutorial.

Make sure you name the project elementary_tutorial.

3. Connect to the Tutorial Repo

Connect to the forked repository.

4. Seed Data to our DWH

After creating a branch, we will populate our DWH with the sample data:

dbt seed

Now, let’s add Elementary’s package into our project.

​Before you start:

​Setting Up Your Tutorial Project: