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

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.

To connect to DocuSign, set the following connection properties:

• UseSandbox: indicates whether current user account is sandbox or not (FALSE by default)
• AccountId (optional): set it in the connection string if you have access to multiple Account Ids

Authenticating to DocuSign

DocuSign uses the OAuth authentication standard. To authenticate using OAuth, create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Help documentation more information.

Below is the syntax for a DSN:

[CData DocuSign Source]
Driver = CData ODBC Driver for DocuSign
Description = My Description
OAuthClientId = MyClientId
 OAuthClientSecret = MyClientSecret
 
CallbackURL = http://localhost:33333

Execute SQL to DocuSign

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 DocuSign};OAuthClientId = MyClientId; OAuthClientSecret = MyClientSecret; 
CallbackURL = http://localhost:33333;
')
cursor = cnxn.cursor()
cursor.execute("SELECT DocumentId, DocumentName FROM Documents WHERE DocumentName = 'TPSReport'")
rows = cursor.fetchall()
for row in rows:
 print(row.DocumentId, row.DocumentName)

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