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

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

Connecting to Pipeliner CRM Data

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

Pipeliner CRM API Profile Settings

Navigate to Administration > Obtain API Key within your Pipeliner CRM workspace to retrieve the API Token, API Password, Space ID, and Service URL.

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

cnxn = mod.connect("Profile=C:\profiles\Pipeliner.apip;ProfileSettings='User=your_api_token;Password=your_api_password;SpaceId=your_space_id;ServiceUrl=your_service_url';")

Create a SQL Statement to Query Pipeliner CRM

Use SQL to create a statement for querying Pipeliner CRM. In this article, we read data from the Account entity.

sql = "SELECT Success, Id FROM Account WHERE Name = 'Acme Corporation'"

Extract, Transform, and Load the Pipeliner CRM Data

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

Loading Pipeliner CRM Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

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

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

With the CData API Driver for Python, you can work with Pipeliner CRM 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 Pipeliner CRM 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\Pipeliner.apip;ProfileSettings='User=your_api_token;Password=your_api_password;SpaceId=your_space_id;ServiceUrl=your_service_url';")

sql = "SELECT Success, Id FROM Account WHERE Name = 'Acme Corporation'"

table1 = etl.fromdb(cnxn,sql)

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

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