Ready to get started?

Learn more about the CData ODBC Driver for Smartsheet or download a free trial:

Download Now

Using the CData ODBC Driver for Smartsheet in PyCharm

Connect to Smartsheet as an ODBC data source in PyCharm using the CData ODBC Driver for Smartsheet.

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 Smartsheet 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 Smartsheet 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 Smartsheet

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.

Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

However, for testing purposes you can instead use the Personal Access Token you get when you create an application; set this to the OAuthAccessToken connection property.

Below is the syntax for a DSN:

[CData Smartsheet Source] Driver = CData ODBC Driver for Smartsheet Description = My Description OAuthClientId = MyOauthClientId OAuthClientSecret = MyOAuthClientSecret CallbackURL = http://localhost:33333

Execute SQL to Smartsheet

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 Smartsheet};OAuthClientId = MyOauthClientId;OAuthClientSecret = MyOAuthClientSecret;CallbackURL = http://localhost:33333;') cursor = cnxn.cursor() cursor.execute("SELECT TaskName, Progress FROM Sheet_Event_Plan_Budget WHERE Assigned = 'Ana Trujilo'") rows = cursor.fetchall() for row in rows: print(row.TaskName, row.Progress)

After connecting to Smartsheet in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Smartsheet data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at support@cdata.com.