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

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

ActiveTrail API Profile Settings

ActiveTrail uses API key authentication. To obtain an API key:

1. Log in to your ActiveTrail account at https://app.activetrail.com
2. Navigate to your account settings and locate the API integration section
3. Generate or copy your existing API key

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your ActiveTrail API key.

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for ActiveTrail
Description = My Description
Profile = C:\profiles\ActiveTrail.apip
AuthScheme = APIKey
APIKey = your_api_key

Execute SQL to ActiveTrail

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\ActiveTrail.apip;AuthScheme = APIKey;APIKey = your_api_key;')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, Email FROM GroupMembers WHERE GroupId = '356069'")
rows = cursor.fetchall()
for row in rows:
  print(row.Id, row.Email)

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