How to use SQLAlchemy ORM to access Deel Data in Python

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData API Driver for Python and the SQLAlchemy toolkit, you can build Deel-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to Deel data to query Deel data.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Deel data in Python. When you issue complex SQL queries from Deel, the CData Connector pushes supported SQL operations, like filters and aggregations, directly to Deel and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Deel Data

Connecting to Deel data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

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';

Follow the procedure below to install SQLAlchemy and start accessing Deel through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit and SQLAlchemy ORM package:

pip install sqlalchemy
pip install sqlalchemy.orm

Be sure to import the appropriate modules:

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Model Deel Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Deel data.

NOTE: Users should URL encode the any connection string properties that include special characters. For more information, refer to the SQL Alchemy documentation.

engine = create_engine("api:///?Profile=C:\profiles\Deel.apip&AuthScheme=APIKey&ProfileSettings='APIKey=your_deel_api_key'")

Declare a Mapping Class for Deel Data

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the Invoices table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base()
class Invoices(base):
	__tablename__ = "Invoices"
	 = Column(String,primary_key=True)
	 = Column(String)
	...

Query Deel Data

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("api:///?Profile=C:\profiles\Deel.apip&AuthScheme=APIKey&ProfileSettings='APIKey=your_deel_api_key'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Invoices).filter_by(=""):
	print(": ", instance.)
	print(": ", instance.)
	print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

Invoices_table = Invoices.metadata.tables["Invoices"]
for instance in session.execute(Invoices_table.select().where(Invoices_table.c. == "")):
	print(": ", instance.)
	print(": ", instance.)
	print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to Deel data. Reach out to our Support Team if you have any questions.