Python のDash ライブラリを使って、Azure DevOps データ に連携するウェブアプリケーションを開発する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Python エコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for AzureDevOps を使うことで、pandas モジュールとDash フレームワークでAzure DevOps にデータ連携するアプリケーションを効率的に開発することができます。本記事では、pandas、Dash とCData Connector を使って、Azure DevOps に連携して、Azure DevOps データ をビジュアライズするシンプルなウェブアプリを作る方法をご紹介します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. Azure DevOps をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Dash をはじめとする多様なデータ分析・BI ツールにAzure DevOps データを連携
3. ノーコードでの手軽な接続設定

必要なモジュールのインストール

まずは、pip で必要なモジュールおよびフレームワークをインストールします：

pip install pandas
pip install dash
pip install dash-daq

Python でAzure DevOps データを可視化

必要なモジュールとフレームワークがインストールされたら、ウェブアプリを開発していきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に掲載しているので、参考にしてください。

まず、CData Connector を含むモジュールをインポートします：

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

接続文字列を使ってデータへの接続を確立します。connect 関数を使ってCData Azure DevOps Connector からAzure DevOps データ との接続を確立します。

cnxn = mod.connect("AuthScheme=Basic;Organization=MyAzureDevOpsOrganization;ProjectId=MyProjectId;PersonalAccessToken=MyPAT;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

AzureDevOps 接続プロパティの取得・設定方法

Azure DevOps アカウントに接続するには、Profile -> Organizations に移動して、アカウント内の組織名であるOrganization を指定します。

例： Organization=MyAzureDevOpsOrganization

NOTE ：Analytics スキーマに接続する場合は、Organization と一緒にProjectId を指定する必要があります。

Azure DevOps への認証

Basic

Azure AD

Azure DevOps にクエリを実行

read_sql 関数を使って、padas からSQL 文を発行し、DataFrame に結果を格納します。

df = pd.read_sql("""SELECT Id, BuildNumber FROM Builds WHERE Reason = 'Manual'""", cnxn)

ウェブアプリケーションの設定

DataFrame に格納されたクエリ結果を使って、ウェブアプリにname、stylesheet、title を設定していきます。

app_name = 'dash-azuredevopsedataplot'

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

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

Layout 設定

次に、Azure DevOps データ をベースにした棒グラフを作詞し、アプリのレイアウトを設定します。

trace = go.Bar(x=df.Id, y=df.BuildNumber, name='Id')

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

アプリをセットアップして実行

接続、アプリ、レイアウトを定義したら、アプリを実行してみましょう。以下のコードで実行できます。

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

最後に、Python でウェブアプリを起動してブラウザでAzure DevOps データ を見てみましょう。

python azuredevops-dash.py

ちゃんとデータが表示できてますね！

おわりに

Azure DevOps Python Connector の30日の無償トライアル をぜひダウンロードして、Azure DevOps データ への接続をPython アプリやスクリプトから簡単に作成してみてください。

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

cnxn = mod.connect("AuthScheme=Basic;Organization=MyAzureDevOpsOrganization;ProjectId=MyProjectId;PersonalAccessToken=MyPAT;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

df = pd.read_sql("SELECT Id, BuildNumber FROM Builds WHERE Reason = 'Manual'", cnxn)
app_name = 'dash-azuredevopsdataplot'

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.BuildNumber, name='Id')

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

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