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

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.

You need an API key to connect to Greenhouse. To create an API key, follow the steps below:

1. Click the Configure icon in the navigation bar and locate Dev Center on the left.
2. Select API Credential Management.
3. Click Create New API Key.
• Set "API Type" to Harvest.
• Set "Partner" to custom.
• Optionally, provide a description.
4. Proceed to Manage permissions and select the appropriate permissions based on the resources you want to access through the driver.
5. Copy the created key and set APIKey to that value.

Below is the syntax for a DSN:

[CData Greenhouse Source]
Driver = CData ODBC Driver for Greenhouse
Description = My Description
APIKey = YourAPIKey

Execute SQL to Greenhouse

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 Greenhouse};APIKey = YourAPIKey;')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, CandidateId FROM Applications WHERE Status = 'Active'")
rows = cursor.fetchall()
for row in rows:
 print(row.Id, row.CandidateId)

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