Using the CData ODBC Driver for Perigon 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 Perigon 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 Perigon 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 Perigon
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.
Using API Key Authentication
To use the Perigon API, you need to obtain an API key from your Perigon account. Navigate to the Perigon dashboard and generate an API key from your account settings.
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Perigon API key.
Example connection string:
Profile=C:\profiles\Perigon.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"
Available Tables
The Perigon profile provides access to the following tables:
- Articles - News articles retrieved from the Perigon news intelligence API
- Headlines - Story clusters grouping related headline articles
- Sources - News sources tracked by the Perigon news intelligence API
- Journalists - Journalist profiles tracked by the Perigon news intelligence API
Below is the syntax for a DSN:
[CData API Source] Driver = CData ODBC Driver for Perigon Description = My Description Profile = C:\profiles\Perigon.apip AuthScheme = APIKey ProfileSettings = "APIKey = your_api_key"
Execute SQL to Perigon
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\Perigon.apip;AuthScheme = APIKey;ProfileSettings = "APIKey = your_api_key"')
cursor = cnxn.cursor()
cursor.execute("SELECT , FROM Articles WHERE = ''")
rows = cursor.fetchall()
for row in rows:
print(row., row.)
After connecting to Perigon in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Perigon 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].