Using the CData ODBC Driver for Highrise 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 Highrise 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 Highrise 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 Highrise

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.

Highrise uses the OAuth authentication standard. To authenticate to Highrise, obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

See the "Getting Started" section in the help documentation for a guide to using OAuth.

Below is the syntax for a DSN:

[CData Highrise Source]
Driver = CData ODBC Driver for Highrise
Description = My Description
OAuthClientId = MyOAuthClientId
OAuthClientSecret = MyOAuthClientSecret
CallbackURL = http://localhost
AccountId = MyAccountId
InitiateOAuth = GETANDREFRESH

Execute SQL to Highrise

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 Highrise};OAuthClientId = MyOAuthClientId;OAuthClientSecret = MyOAuthClientSecret;CallbackURL = http://localhost;AccountId = MyAccountId;InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT Name, Price FROM Deals WHERE GroupId = 'MyGroupId'")
rows = cursor.fetchall()
for row in rows:
 print(row.Name, row.Price)

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