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

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

Connecting to ShipEngine Data

Connecting to ShipEngine 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 ShipEngine Profile on disk (e.g. C:\profiles\ShipEngine.apip). Next, set the ProfileSettings connection property to the connection string for ShipEngine (see below).

ShipEngine API Profile Settings

Retrieve your ShipEngine API Key from the Dashboard at app.shipengine.com under API Management.

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

cnxn = mod.connect("Profile=C:\profiles\ShipEngine.apip;ProfileSettings='APIKey=your_api_key';")

Create a SQL Statement to Query ShipEngine

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

sql = "SELECT BatchId, Error FROM BatchErrors WHERE BatchId = 'batch_123'"

Extract, Transform, and Load the ShipEngine Data

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

Loading ShipEngine Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

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

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

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

sql = "SELECT BatchId, Error FROM BatchErrors WHERE BatchId = 'batch_123'"

table1 = etl.fromdb(cnxn,sql)

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

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