Using the CData ODBC Driver for AgileCRM 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 AgileCRM 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 AgileCRM as well as PyCharm.
Add Pyodbc to the Project
Follow the steps below to add the pyodbc module to your project.
- Click File -> Settings to open the project settings window.
- Click Project Interpreter from the Project: YourProjectName menu.
- To add pyodbc, click the + button and enter pyodbc.
- Click Install Package to install pyodbc.
Connect to AgileCRM
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 AgileCRM Profile on disk (e.g. C:\profiles\Agilecrm.apip). Next, set the ProfileSettings connection property to the connection string for AgileCRM (see below).
AgileCRM API Profile Settings
Log in to AgileCRM and go to Admin Settings > Developers & API > REST API to find your API key. Your domain is the subdomain from your AgileCRM account URL.
Below is the syntax for a DSN:
[CData API Source] Driver = CData ODBC Driver for AgileCRM Description = My Description Profile = C:\profiles\Agilecrm.apip ProfileSettings = 'APIKey = your_api_key Domain = your_domain User = your_email'
Execute SQL to AgileCRM
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\Agilecrm.apip;ProfileSettings = 'APIKey = your_api_key;Domain = your_domain;User = your_email';')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, Name FROM Campaigns WHERE IsDisabled = 'false'")
rows = cursor.fetchall()
for row in rows:
print(row.Id, row.Name)
After connecting to AgileCRM in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to AgileCRM 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].