Using the CData ODBC Driver for Clockify in PyCharm

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

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

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 Clockify Profile on disk (e.g. C:\profiles\Clockify.apip). Next, set the ProfileSettings connection property to the connection string for Clockify (see below).

Clockify API Profile Settings

Log into your Clockify account, navigate to Profile Settings, and copy the API key from the API section.

Below is the syntax for a DSN:

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

Execute SQL to Clockify

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\Clockify.apip;ProfileSettings = 'APIKey = your_api_key';')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, WorkspaceId FROM ApprovalRequests WHERE StatusState = 'PENDING'")
rows = cursor.fetchall()
for row in rows:
  print(row.Id, row.WorkspaceId)

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

Connect to Clockify