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

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create ETL applications and real-time data pipelines for Deel data in Python with petl.

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

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

Connecting to Deel Data

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

To authenticate to Deel, you can use API Key (Bearer Token) authentication.

Using APIKey Authentication

You can authenticate using a Deel API Key. Create an API key in your Deel account settings under Settings > API or Developer Settings. Make sure to grant appropriate permissions based on the data you need to access (e.g., read access for invoices, timesheets, contracts, workers, etc.).

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

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Deel API Key (Bearer token).

Example APIKey connection string

Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';

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

cnxn = mod.connect("Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';")

Create a SQL Statement to Query Deel

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

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

Extract, Transform, and Load the Deel Data

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

Loading Deel Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'')

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

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

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

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'')

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

Ready to get started?

Connect to live data from Deel with the API Driver

Connect to Deel