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

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

Freshsales API Profile Settings

Retrieve your API Key from Profile Settings > API Settings in the top-right corner of Freshsales. Your Domain is the subdomain from your portal URL.

Below is the syntax for a DSN:

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

Execute SQL to Freshsales

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\Freshsales.apip;ProfileSettings = 'APIKey = your_api_key;Domain = your_subdomain';')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, Name FROM Account WHERE IsDeleted = 'false'")
rows = cursor.fetchall()
for row in rows:
  print(row.Id, row.Name)

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