How to Build an ETL App for Yotpo Data in Python with CData

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData API Driver for Python and the petl framework, you can build Yotpo-connected applications and pipelines for extracting, transforming, and loading Yotpo data. This article shows how to connect to Yotpo with the CData Python Connector and use petl and pandas to extract, transform, and load Yotpo data.

With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Yotpo data in Python. When you issue complex SQL queries from Yotpo, the driver pushes supported SQL operations, like filters and aggregations, directly to Yotpo and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Yotpo Data

Connecting to Yotpo data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

Start by setting the Profile connection property to the location of the Yotpo Profile on disk (e.g. C:\profiles\Yotpo.apip). Next, set the ProfileSettings connection property to the connection string for Yotpo (see below).

Yotpo API Profile Settings

To authenticate to Yotpo, you can use the OAuth 2.0 client credentials flow with your Yotpo AppKey and AppSecret.

To use the Yotpo API, you need a Yotpo store account with an AppKey and AppSecret. You can find these credentials in the Yotpo dashboard under Account Settings > Store.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuthClient.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientId: Set this to your Yotpo AppKey.
• OAuthClientSecret: Set this to your Yotpo AppSecret.

After installing the CData Yotpo Connector, follow the procedure below to install the other required modules and start accessing Yotpo through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install petl
pip install pandas

Build an ETL App for Yotpo Data in Python

Once the required modules and frameworks are installed, we are ready to build our ETL app. Code snippets follow, but the full source code is available at the end of the article.

First, be sure to import the modules (including the CData Connector) with the following:

import petl as etl
import pandas as pd
import cdata.api as mod

You can now connect with a connection string. Use the connect function for the CData Yotpo Connector to create a connection for working with Yotpo data.

cnxn = mod.connect("Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;")

Create a SQL Statement to Query Yotpo

Use SQL to create a statement for querying Yotpo. In this article, we read data from the ProductBottomLine entity.

sql = "SELECT TotalReview, AverageScore FROM ProductBottomLine WHERE ExternalProductId = 'my-product-sku'"

Extract, Transform, and Load the Yotpo Data

With the query results stored in a DataFrame, we can use petl to extract, transform, and load the Yotpo data. In this example, we extract Yotpo data, sort the data by the AverageScore column, and load the data into a CSV file.

Loading Yotpo Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'AverageScore')

etl.tocsv(table2,'productbottomline_data.csv')

With the CData API Driver for Python, you can work with Yotpo data just like you would with any database, including direct access to data in ETL packages like petl.

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to Yotpo data. Reach out to our Support Team if you have any questions.

Full Source Code

import petl as etl
import pandas as pd
import cdata.api as mod

cnxn = mod.connect("Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;")

sql = "SELECT TotalReview, AverageScore FROM ProductBottomLine WHERE ExternalProductId = 'my-product-sku'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'AverageScore')

etl.tocsv(table2,'productbottomline_data.csv')