Learn more
 

Ready to get started?

Connect to live data from Klipfolio with the API Driver

Connect to Klipfolio

In this article

Related articles

Using the CData ODBC Driver for Klipfolio in PyCharm


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

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

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.

Start by setting the Profile connection property to the location of the Klipfolio Profile on disk (e.g. C:\profiles\Klipfolio.apip). Next, set the ProfileSettings connection property to the connection string for Klipfolio (see below).

Klipfolio API Profile Settings

In order to authenticate to Klipfolio, you'll need to provide your API Key. You can generate an API key from the Klipfolio Dashboard app through either the My Profile page or from Users if you are an administrator (you must have the user.manage permission). Set the API Key in the ProfileSettings property to connect.

Below is the syntax for a DSN:

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

Execute SQL to Klipfolio

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\Klipfolio.apip;ProfileSettings = 'APIKey = your_api_key';') cursor = cnxn.cursor() cursor.execute("SELECT Id, Name FROM DataSources WHERE IsDynamic = 'true'") rows = cursor.fetchall() for row in rows: print(row.Id, row.Name)

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