Use Dash to Build to Web Apps on Jira Assets Data

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Python Connector for Jira Assets, the pandas module, and the Dash framework, you can build Jira Assets-connected web applications for Jira Assets data. This article shows how to connect to Jira Assets with the CData Connector and use pandas and Dash to build a simple web app for visualizing Jira Assets data.

With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Jira Assets data in Python. When you issue complex SQL queries from Jira Assets, the driver pushes supported SQL operations, like filters and aggregations, directly to Jira Assets and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Jira Assets Data

Connecting to Jira Assets data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

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.

After installing the CData Jira Assets Connector, follow the procedure below to install the other required modules and start accessing Jira Assets through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install pandas
pip install dash
pip install dash-daq

Visualize Jira Assets Data in Python

Once the required modules and frameworks are installed, we are ready to build our web app. Code snippets follow, but the full source code is available at the end of the article.

First, be sure to import the modules (including the CData Connector) with the following:

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.jiraassets as mod
import plotly.graph_objs as go

You can now connect with a connection string. Use the connect function for the CData Jira Assets Connector to create a connection for working with Jira Assets data.

cnxn = mod.connect("User=MyUser;APIToken=myApiToken;Url=https://yoursitename.atlassian.net")

Execute SQL to Jira Assets

Use the read_sql function from pandas to execute any SQL statement and store the result set in a DataFrame.

df = pd.read_sql("SELECT ID, Name FROM Objects WHERE Label = 'SYD-1'", cnxn)

Configure the Web App

With the query results stored in a DataFrame, we can begin configuring the web app, assigning a name, stylesheet, and title.

app_name = 'dash-jiraassetsedataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'

Configure the Layout

The next step is to create a bar graph based on our Jira Assets data and configure the app layout.

trace = go.Bar(x=df.ID, y=df.Name, name='ID')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='Jira Assets Objects Data', barmode='stack')
		})
], className="container")

Set the App to Run

With the connection, app, and layout configured, we are ready to run the app. The last lines of Python code follow.

if __name__ == '__main__':
    app.run_server(debug=True)

Now, use Python to run the web app and a browser to view the Jira Assets data.

python jiraassets-dash.py

Free Trial & More Information

Download a free, 30-day trial of the CData Python Connector for Jira Assets to start building Python apps with connectivity to Jira Assets data. Reach out to our Support Team if you have any questions.

Full Source Code

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.jiraassets as mod
import plotly.graph_objs as go

cnxn = mod.connect("User=MyUser;APIToken=myApiToken;Url=https://yoursitename.atlassian.net")

df = pd.read_sql("SELECT ID, Name FROM Objects WHERE Label = 'SYD-1'", cnxn)
app_name = 'dash-jiraassetsdataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'
trace = go.Bar(x=df.ID, y=df.Name, name='ID')

app.layout = html.Div(children=[html.H1("CData Extension + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(title='Jira Assets Objects Data', barmode='stack')
		})
], className="container")

if __name__ == '__main__':
    app.run_server(debug=True)