How to Build an ETL App for GitLab Data in Python with CData Connect AI

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Connect AI Python SDK and the petl framework, you can build GitLab-connected applications and pipelines for extracting, transforming, and loading GitLab data. This article shows how to connect to Connect AI and use petl to extract, transform, and load GitLab data.

The Connect AI Python SDK (cdata-connect-ai) is a DB-API 2.0 (PEP 249) compliant client, so petl can read directly from the SDK connection with etl.fromdb. There is no driver to install per source: connect with a Personal Access Token and build your pipeline.

Connect to GitLab in Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "GitLab" from the Add Connection panel

3. Enter the necessary authentication properties to connect to GitLab.

   To connect to GitLab, use either OAuth or a personal access token:

   Using OAuth

   Register an OAuth application in GitLab under Edit Profile > Applications (or group Settings > Applications). Set the Redirect URI to https://oauth.cdata.com/oauth/. Note the Application ID (OAuth Client Id) and Secret (shown once). Then set:

   • OAuth Client Id: The Application ID from your GitLab OAuth application.
   • OAuth Client Secret: The Secret from your GitLab OAuth application.

   Click Sign In to complete OAuth authentication.

   Using a Personal Access Token

   In GitLab, navigate to Edit Profile > Access Tokens > Add new token. Select the required scopes (such as api, read_api, read_user, read_repository) and set an expiration date. Copy the token immediately (shown only once). Then set:

   • API Key: The personal access token from your GitLab account.
   
4. Click Save & Test
5. Navigate to the Permissions tab and update the user-based permissions.

Generate a Personal Access Token (PAT)

The Python SDK authenticates to Connect AI with your account email and a Personal Access Token (PAT). It is best practice to create a separate PAT for each application to maintain granularity of access.

1. Click the Gear icon () at the top right of the Connect AI app to open the Settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The PAT is only visible at creation, so copy it and store it securely.

Install Required Modules

Install the SDK and the petl framework using the pip utility:

pip install cdata-connect-ai
pip install petl

Build an ETL App for GitLab Data in Python

Once the required modules are installed, you are ready to build the ETL app. Code snippets follow, but the full source code is available at the end of the article.

First, import the modules and connect to Connect AI with your account email and PAT:

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

Create a SQL Statement to Query GitLab

Use SQL to create a statement for querying GitLab. In this article, we read data from the AccessRequests entity. Identifiers are three-part: <Connection>.<Schema>.<Table>, where the connection name defaults to the source name (for example, API1).

sql = (
    "SELECT Id, Username "
    "FROM [API1].[API].[AccessRequests] "
    "WHERE State = 'pending'"
)

Extract, Transform, and Load the GitLab Data

With a connection and query in hand, use petl to extract, transform, and load the GitLab data. In this example, we extract GitLab data, sort the data by the Username column, and load the data into a CSV file.

table1 = etl.fromdb(conn, sql)

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

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

GitLab is a read-only source in Connect AI, so this pipeline can extract and transform GitLab data but not load rows back. Close the connection when the extract is complete:

conn.close()

With the CData Connect AI Python SDK, you can work with GitLab data just like you would with any database, including direct access to data in ETL packages like petl.

More Information and Free Trial

Now you can pipe live GitLab data through petl using the CData Connect AI Python SDK. For more information on connecting to GitLab (and hundreds of other data sources), visit the Connect AI page. Sign up for a free trial and start building data pipelines for live GitLab data in Python.

Full Source Code

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT Id, Username "
    "FROM [API1].[API].[AccessRequests] "
    "WHERE State = 'pending'"
)

table1 = etl.fromdb(conn, sql)

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

etl.tocsv(table2, 'accessrequests_data.csv')
conn.close()