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

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.

Using API Key Authentication

Paddle uses API key authentication. To obtain an API key:

1. Sign in to your Paddle account at https://vendors.paddle.com
2. Navigate to Developer Tools > Authentication
3. Click "Generate API Key"
4. Assign the appropriate permissions for the data you wish to access
5. Copy the generated key (sandbox keys begin with pdl_sdbx_apikey_; production keys begin with pdl_live_apikey_)

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.

• APIKey: Set this to your Paddle API key.

Example Connection String

Profile=C:\profiles\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Connecting to Paddle

Once the authentication is configured, you can connect to Paddle and query data from any of the available tables such as Products, Customers, Subscriptions, and Transactions.

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for Paddle
Description = My Description
Profile = C:\profiles\Paddle.apip
AuthScheme = APIKey
ProfileSettings = "APIKey = your_api_key"

Execute SQL to Paddle

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 API};Profile = C:\profiles\Paddle.apip;AuthScheme = APIKey;ProfileSettings = "APIKey = your_api_key";')
cursor = cnxn.cursor()
cursor.execute("SELECT ,  FROM Products WHERE  = ''")
rows = cursor.fetchall()
for row in rows:
  print(row., row.)

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