Ready to get started?

Download a free trial of the TSheets Connector to get started:

 Download Now

Learn more:

TSheets Icon TSheets Python Connector

Python Connector Libraries for TSheets Data Connectivity. Integrate TSheets with popular Python tools like Pandas, SQLAlchemy, Dash & petl.

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



The CData Python Connector for TSheets enables you to create ETL applications and pipelines for TSheets 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 Python Connector for TSheets and the petl framework, you can build TSheets-connected applications and pipelines for extracting, transforming, and loading TSheets data. This article shows how to connect to TSheets with the CData Python Connector and use petl and pandas to extract, transform, and load TSheets data.

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

Connecting to TSheets Data

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

TSheets uses the OAuth2 standard for authentication and authorization. To construct your own OAuth app and connect to data, refer to OAuth section in the Help.

After installing the CData TSheets Connector, follow the procedure below to install the other required modules and start accessing TSheets 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 TSheets 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.tsheets as mod

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

cnxn = mod.connect("OAuthClientId=myclientid;OAuthClientSecret=myclientsecret;CallbackUrl=http://localhost:33333;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

Create a SQL Statement to Query TSheets

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

sql = "SELECT Id, JobcodeId FROM Timesheets WHERE JobCodeType = 'regular'"

Extract, Transform, and Load the TSheets Data

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

Loading TSheets Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

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

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

With the CData Python Connector for TSheets, you can work with TSheets 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 Python Connector for TSheets to start building Python apps and scripts with connectivity to TSheets 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.tsheets as mod

cnxn = mod.connect("OAuthClientId=myclientid;OAuthClientSecret=myclientsecret;CallbackUrl=http://localhost:33333;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

sql = "SELECT Id, JobcodeId FROM Timesheets WHERE JobCodeType = 'regular'"

table1 = etl.fromdb(cnxn,sql)

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

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