Using the CData ODBC Driver for Azure DevOps in PyCharm

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Azure DevOps from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Azure DevOps as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

1. Click File -> Settings to open the project settings window.
2. Click Project Interpreter from the Project: YourProjectName menu.
3. To add pyodbc, click the + button and enter pyodbc.
4. Click Install Package to install pyodbc.

👁 Image

Connect to Azure DevOps

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

You can connect to your Azure DevOps account by providing the Organization and PersonalAccessToken.

Obtaining a Personal Access Token

A PersonalAccessToken is necessary for account authentication.

To generate one, log in to your Azure DevOps Organization account and navigate to Profile -> Personal Access Tokens -> New Token. The generated token will be displayed.

If you wish to authenticate to Azure DevOps using OAuth refer to the online Help documentation for an authentication guide.

Below is the syntax for a DSN:

[CData AzureDevOps Source]
Driver = CData ODBC Driver for Azure DevOps
Description = My Description
AuthScheme = Basic
Organization = MyAzureDevOpsOrganization
ProjectId = MyProjectId
PersonalAccessToken = MyPAT
InitiateOAuth = GETANDREFRESH

Execute SQL to Azure DevOps

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for AzureDevOps};AuthScheme = Basic;Organization = MyAzureDevOpsOrganization;ProjectId = MyProjectId;PersonalAccessToken = MyPAT;InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, BuildNumber FROM Builds WHERE Reason = 'Manual'")
rows = cursor.fetchall()
for row in rows:
 print(row.Id, row.BuildNumber)

After connecting to Azure DevOps in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Azure DevOps data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].