Using the CData ODBC Driver for CloudConvert in PyCharm

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to CloudConvert as an ODBC data source in PyCharm using the CData ODBC Driver for CloudConvert.

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

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.

CloudConvert uses API key authentication. Your CloudConvert API key is used to authenticate requests as a Bearer token. You can generate or view your keys at https://cloudconvert.com/dashboard/api/v2/keys.

Using API Key Authentication

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your CloudConvert API key.

Example connection string:

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

Below is the syntax for a DSN:

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

Execute SQL to CloudConvert

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\CloudConvert.apip;AuthScheme = APIKey;ProfileSettings = "APIKey = your_api_key";')
cursor = cnxn.cursor()
cursor.execute("SELECT ,  FROM Jobs WHERE  = ''")
rows = cursor.fetchall()
for row in rows:
  print(row., row.)

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

Ready to get started?

Connect to live data from CloudConvert with the API Driver

Connect to CloudConvert