【徹底解説】Dash を使ってPython からCircleCI のデータに連携するアプリを簡単に開発

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

CData Python Connectors の特徴

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

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

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

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

pip install pandas
pip install dash
pip install dash-daq

Python でCircleCI のデータを可視化

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

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

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

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

cnxn = mod.connect("Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';")

API キー認証の設定

CircleCI は、API リクエストの認証にパーソナル API トークンを使用します。パーソナル API トークンを生成するには、CircleCI アカウントにログインし、User Settings > Personal API Tokens に移動して、Create New Token をクリックします。トークンの値は一度しか表示されないため、すぐにコピーしてください。

以下の接続プロパティを設定して接続を確立してください：

• AuthScheme：APIKey に設定します。
• APIKey：CircleCI のパーソナル API トークンに設定します。

接続文字列の例：

Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';

CircleCI にクエリを実行

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

df = pd.read_sql("""SELECT ,  FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'""", cnxn)

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

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

app_name = 'dash-apiedataplot'

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

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

Layout 設定

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

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

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='CircleCI Artifacts Data', barmode='stack')
		})
], className="container")

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

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

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

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

python api-dash.py

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

おわりに

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

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

cnxn = mod.connect("Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';")

df = pd.read_sql("SELECT ,  FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'", cnxn)
app_name = 'dash-apidataplot'

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., y=df., name='')

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='CircleCI Artifacts Data', barmode='stack')
		})
], className="container")

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