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

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.

To authenticate to Deel, you can use API Key (Bearer Token) authentication.

Using APIKey Authentication

You can authenticate using a Deel API Key. Create an API key in your Deel account settings under Settings > API or Developer Settings. Make sure to grant appropriate permissions based on the data you need to access (e.g., read access for invoices, timesheets, contracts, workers, etc.).

After creating your API Key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Deel API Key (Bearer token).

Example APIKey connection string

Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';

Below is the syntax for a DSN:

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

Execute SQL to Deel

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

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