Using the CData ODBC Driver for Microsoft Planner 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 Microsoft Planner 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 Microsoft Planner 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.

Connect to Microsoft Planner

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 without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

When you connect the Driver opens the MS Planner OAuth endpoint in your default browser. Log in and grant permissions to the Driver. The Driver then completes the OAuth process.

1. Extracts the access token from the callback URL and authenticates requests.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Below is the syntax for a DSN:

[CData MicrosoftPlanner Source]
Driver = CData ODBC Driver for Microsoft Planner
Description = My Description
OAuthClientId = MyApplicationId
OAuthClientSecret = MySecretKey
CallbackURL = http://localhost:33333
InitiateOAuth = GETANDREFRESH

Execute SQL to Microsoft Planner

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 MicrosoftPlanner};OAuthClientId = MyApplicationId;OAuthClientSecret = MySecretKey;CallbackURL = http://localhost:33333;InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT TaskId, startDateTime FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK'")
rows = cursor.fetchall()
for row in rows:
 print(row.TaskId, row.startDateTime)

After connecting to Microsoft Planner in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Microsoft Planner 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].