Learn more
 

Use JayDeBeApi to access Jira Assets Data in Python


Use standard Python scripting and the development environment of your choice to access live Jira Assets data.

Access Jira Assets data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for Jira Assets and the JayDeBeApi module to work with remote Jira Assets data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to Jira Assets and visualize Jira Assets data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with Jira Assets data in Python using SQL.

Jira Assets supports connecting and authenticating via the APIToken.

To generate an API token:

  1. Log in to your Atlassian account.
  2. Navigate to Security < Create and manage API Token < Create API Token.

Atlassian generates and then displays the API token.

After you have generated the API token, set these parameters:

  • AuthScheme: APIToken.
  • User: The login of the authenticating user.
  • APIToken: The API token you just generated.

You are now ready to connect and authenticate to Jira Assets.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Jira Assets JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.jiraassets.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:jiraassets:User=MyUser;APIToken=myApiToken;Url=https://yoursitename.atlassian.net"

Access Jira Assets data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.jiraassets.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from Jira Assets:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:jiraassets:User=MyUser;APIToken=myApiToken;Url=https://yoursitename.atlassian.net" username = "****" password = "****" #The absolute Path to the JDBC driver JAR file, typically: jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.jiraassets.jar" conn = jaydebeapi.connect( "cdata.jdbc.jiraassets.JiraAssetsDriver", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Objects;") results = cursor.fetchall() for row in results: print(row) cursor.close() conn.close()

Free trial & more information

Download a free, 30-day trial of the CData JDBC Driver for Jira Assets and start working with your live Jira Assets data in Python. Reach out to our Support Team if you have any questions.

Ready to get started?

Download a free trial of the Jira Assets Driver to get started:

 Download Now

Learn more:

Jira Assets Icon Jira Assets JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Jira Assets.

In this article

Related articles