Python Jira Connector In this article you will learn how to integrate Jira data to Python (live / bi-directional connection to Jira). Jira Connector can be used to integrate Jira and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete Issues, Users, Worklogs, Comments just in a few clicks!. Using Jira Connector you will be able to connect, read, and write data from within Python. Follow the steps below to see how we would accomplish that. Download  Help File  Buy  Driver mentioned in this article is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. ODBC PowerPack - System Requirements and Installation Getting Started - Using ODBC PowerPack ODBC API Driver Help File

See also Connect Jira in SSIS Connect Jira in SQL Server Connect Jira in Power BI Connect Jira in SSRS Connect Jira in Informatica Connect Jira in MS Access Connect Jira in MS Excel Connect Jira in SSAS Connect Jira in C# Connect Jira in JAVA Connect Jira in Tableau Connect Jira in SAP Crystal Reports Connect Jira in Azure Data Factory (ADF) Connect Jira in ODBC

Create ODBC Data Source (DSN) based on ZappySys API Driver

To get data from Jira using Python we first need to create a DSN (Data Source) which will access data from Jira. We will later be able to read data using Python. Perform these steps:

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):
   

3. Create a User Data Source (User DSN) based on ZappySys API Driver

   ZappySys API Driver

   
   You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.

4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Jira" from the list of Popular Connectors. If "Jira" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

   JiraDSN

   Jira

   

5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    Http [Http]

   Steps to get Jira Credentials
   Firstly, login into your Atlassian account and then go to your Jira profile:

   1. Go to Profile > Security.
   2. Click Create and manage API tokens.
   3. Then click Create API token button and give your token a label.
   4. When window appears with new API token, copy and use it in this connection manager.
   5. That's it!

   Fill in all required parameters and set optional parameters if needed:

   JiraDSN

   Jira

   Http [Http]

   https://[$Subdomain$].atlassian.net/rest/api/3

   Required Parameters
   Subdomain	Fill in the parameter...
   Atlassian User Name (email)	Fill in the parameter...
   API Key	Fill in the parameter...
   Optional Parameters

   

    OAuth Authentication [OAuth]

   OAuth App must be created in Atlassian Developer Console. It is found at https://developer.atlassian.com/console/myapps/ [Read more..]

   Steps to get Jira Credentials
   Firstly, login into your Atlassian account and then create Jira application:

   1. Go to Atlassian Developer area.
   2. Click Create app and select OAuth 2.0 (3LO) integration app to create an OAuth app.
   3. Give your app a name, accept the terms and hit Create.
   4. Then hit App details panel and copy paste Client ID and Secret into the API Connection Manager configuration grid into the proper places.
   5. Then go back and click Permissions panel to enable permissions/scopes for your application. You can enable them all.
   6. Go back again to application settings and click Authorization panel.
   7. Click Configure button and in Callback URL enter your own Callback URL or simply enter https://zappysys.com/oauth if you don't have one.
   8. Use this same Callback URL (Return URL) in a API Connection Manager configuration grid.
   9. In API Connection Manager enter one or more of these scopes (read more about available scopes) into Scopes property:
      1. offline_access (a must)
      2. read:jira-user
      3. read:jira-work
      4. write:jira-work
      5. manage:jira-project
      6. manage:jira-configuration
   10. Also configure your company's Subdomain in the properties grid.
   11. Click Generate Token to generate tokens.
   12. That's it!

   Fill in all required parameters and set optional parameters if needed:

   JiraDSN

   Jira

   OAuth Authentication [OAuth]

   https://[$Subdomain$].atlassian.net/rest/api/3

   Required Parameters
   Subdomain	Fill in the parameter...
   ClientId	Fill in the parameter...
   ClientSecret	Fill in the parameter...
   Scope	Fill in the parameter...
   ReturnUrl	Fill in the parameter...
   Optional Parameters

   

6. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
   

7. Click OK to finish creating the data source.

Read data in Python from the DSN

1. Python code to get the data:
   

   JiraDSN')

   

2. When you run the code it will make the API call and read the data:
   

3. Here is Python program's code in text format:

   
   import pyodbc
   
   conn = pyodbc.connect('DSN=JiraDSN')
   
   cursor = conn.cursor() 
   
   #execute query to fetch data from API service
   cursor.execute("SELECT * FROM value") 
   row = cursor.fetchone() 
   while row: 
   print (row[1]) 
   row = cursor.fetchone()
   

4. If you want to avoid to be dependent on a DSN name and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String . Then in your Python code use Connection String when initializing OdbcConnection object, for example:

   conn = pyodbc.connect('DRIVER={ZappySys API Driver};ServiceUrl=https://services.odata.org/V3/Northwind/Northwind.svc;Provider=OData;AuthName=Http;')
   

Create Custom Store Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
   

2. Enter the desired Procedure name and click on OK:
   

3. Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
   Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
   

   CREATE PROCEDURE [usp_get_orders]
       @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
    AS
       SELECT * FROM Orders where OrderDate >= '<@fromdate>';
   

   
   

4. That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
   

   Exec usp_get_orders '1996-01-01';

   
   

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
   

2. Enter the desired Table name and click on OK:
   

3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
   Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
   

   SELECT
     "ShipCountry",
     "OrderID",
     "CustomerID",
     "EmployeeID",
     "OrderDate",
     "RequiredDate",
     "ShippedDate",
     "ShipVia",
     "Freight",
     "ShipName",
     "ShipAddress",
     "ShipCity",
     "ShipRegion",
     "ShipPostalCode"
   FROM "Orders"
   Where "ShipCountry"='USA'

   
   

5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
   

   SELECT * FROM "vt__usa_orders_only"

   
   

Conclusion

Download Jira Connector for Python Documentation 

Actions supported by Jira Connector

Other App Integration scenarios for Jira

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (ADF)

ODBC

Other Connectors for Python

Zendesk

ManagedEngine ServiceDesk Plus (Zoho)

Zoho CRM

Hubspot

Google Sheets

Stripe

YouTube

Google BigQuery

OneDrive

OData

Amazon Ads

Jira

Zoom

Nativo

Google Drive

SharePoint Online

Amazon MWS

ElasticSearch

Google Calendar

DropBox

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Download Jira Connector for Python Documentation 

Common Searches: