How to Build an ETL App for Workable 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 Workable-connected applications and pipelines for extracting, transforming, and loading Workable data. This article shows how to connect to Workable with the CData Python Connector and use petl and pandas to extract, transform, and load Workable data.

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

Connecting to Workable Data

Connecting to Workable 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.

Using API Key Authentication

Workable uses API key authentication to control access to the API. To obtain an API Key:

1. Log in to your Workable account.
2. Navigate to Settings > Integrations > API Access Tokens.
3. Click "Generate API Token".
4. Copy the generated token.

After obtaining your API Key, set the following connection properties:

• AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

• APIKey: Set this to your Workable API Key.
• Subdomain: Set this to your Workable account subdomain. For example, if your Workable URL is acmeinc.workable.com, then the Subdomain is 'acmeinc'.

Example Connection String

Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';

After installing the CData Workable Connector, follow the procedure below to install the other required modules and start accessing Workable 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 Workable 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 Workable Connector to create a connection for working with Workable data.

cnxn = mod.connect("Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';")

Create a SQL Statement to Query Workable

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

sql = "SELECT ,  FROM Accounts WHERE  = ''"

Extract, Transform, and Load the Workable Data

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

Loading Workable Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'')

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

With the CData API Driver for Python, you can work with Workable 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 Workable 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\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';")

sql = "SELECT ,  FROM Accounts WHERE  = ''"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'')

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