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

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.

WooCommerce supports the following authentication methods: one-legged OAuth1.0 Authentication and standard OAuth2.0 Authentication.

Connecting using one-legged OAuth 1.0 Authentication

Specify the following properties (NOTE: the below credentials are generated from WooCommerce settings page and should not be confused with the credentials generated by using WordPress OAuth2.0 plugin):

• ConsumerKey
• ConsumerSecret

Connecting using WordPress OAuth 2.0 Authentication

After having configured the

• OAuthClientId
• OAuthClientSecret
• CallbackURL
• InitiateOAuth - Set this to either GETANDREFRESH or REFRESH

In either case, set the Url property to the URL of the WooCommerce instance.

Below is the syntax for a DSN:

[CData WooCommerce Source]
Driver = CData ODBC Driver for WooCommerce
Description = My Description
Url = https://example.com/
 ConsumerKey = ck_ec52c76185c088ecaa3145287c8acba55a6f59ad
 ConsumerSecret = cs_9fde14bf57126156701a7563fc87575713c355e5
InitiateOAuth = GETANDREFRESH

Execute SQL to WooCommerce

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 WooCommerce};Url = https://example.com/; ConsumerKey = ck_ec52c76185c088ecaa3145287c8acba55a6f59ad; ConsumerSecret = cs_9fde14bf57126156701a7563fc87575713c355e5;InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT ParentId, Total FROM Orders WHERE ParentId = '3'")
rows = cursor.fetchall()
for row in rows:
 print(row.ParentId, row.Total)

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