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

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.

You can authenticate to Linear with a personal API key or with OAuth 2.0. The API key is the simplest option for connecting with your own Linear account.

Authenticating with an API Key

Set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: A Linear personal API key.

To create a personal API key, log in to Linear, open Settings > Security & access > Personal API keys, select New API key, and create it. Copy the key immediately, because Linear shows it only once.

Authenticating with OAuth

OAuth requires a custom OAuth application registered in Linear (Settings > API > OAuth applications), which provides the OAuthClientId and OAuthClientSecret. Two flows are supported:

• Authorization code: Set AuthScheme to OAuth, InitiateOAuth to GETANDREFRESH, and provide OAuthClientId, OAuthClientSecret, and the CallbackURL defined in your application (e.g., http://localhost:33333). The driver opens Linear in your browser so you can grant access.
• Client credentials: Set AuthScheme to OAuthClient and provide OAuthClientId and OAuthClientSecret. This authenticates the application itself, with no browser interaction, and suits machine-to-machine integrations.

By default, the driver requests the read,write scopes. The driver refreshes the access token automatically when it expires.

Below is the syntax for a DSN:

[CData Linear Source]
Driver = CData ODBC Driver for Linear
Description = My Description
AuthScheme = APIKey
APIKey = myAPIKey

Execute SQL to Linear

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 Linear};AuthScheme = APIKey;APIKey = myAPIKey;')
cursor = cnxn.cursor()
cursor.execute("SELECT id, name FROM Team WHERE key = 'ENG'")
rows = cursor.fetchall()
for row in rows:
  print(row.id, row.name)

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