Use JayDeBeApi to access Office 365 Data in Python

Access Office 365 data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for Office 365 and the JayDeBeApi module to work with remote Office 365 data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to Office 365 and visualize Office 365 data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with Office 365 data in Python using SQL.

Office 365 uses the OAuth authentication standard. To authenticate requests, obtain the OAuthClientId, OAuthClientSecret, and OAuthCallbackURL by registering an app with Office 365. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Office 365 JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.office365.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:office365:OAuthClientId=MyApplicationId;OAuthClientSecret=MyAppKey;OAuthCallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH;"

Access Office 365 data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.office365.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from Office 365:

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:office365:OAuthClientId=MyApplicationId;OAuthClientSecret=MyAppKey;OAuthCallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH;"

username = "****"
password = "****"

#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.office365.jar"

conn = jaydebeapi.connect(
 "cdata.jdbc.office365.Office365Driver",
 jdbc_url,
 [username, password],
 jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM Files;")


results = cursor.fetchall()
for row in results:
 print(row)

cursor.close()
conn.close()

Free trial & more information

Download a free, 30-day trial of the CData JDBC Driver for Office 365 and start working with your live Office 365 data in Python. Reach out to our Support Team if you have any questions.