【徹底解説】Dash を使ってPython からProcore のデータに連携するアプリを簡単に開発
Python エコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for API を使うことで、pandas モジュールとDash フレームワークでProcore にデータ連携するアプリケーションを効率的に開発することができます。本記事では、pandas、Dash とCData Connector を使って、Procore に連携して、Procore のデータ をビジュアライズするシンプルなウェブアプリを作る方法をご紹介します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- Procore をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Dash をはじめとする多様なデータ分析・BI ツールにProcore のデータを連携
- ノーコードでの手軽な接続設定
必要なモジュールのインストール
まずは、pip で必要なモジュールおよびフレームワークをインストールします:
pip install pandas pip install dash pip install dash-daq
Python でProcore のデータを可視化
必要なモジュールとフレームワークがインストールされたら、ウェブアプリを開発していきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に掲載しているので、参考にしてください。
まず、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 Procore Connector からProcore のデータ との接続を確立します。
cnxn = mod.connect("Profile=C:\profiles\Procore.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;")
まず、Profile 接続プロパティにProcore プロファイルのディスク上の場所を設定します(例:C:\profiles\Procore.apip)。次に、ProfileSettings 接続プロパティにProcore の接続文字列を設定します(以下を参照)。
Procore API プロファイル設定
Procore に認証し、自分のデータに接続したり、他のユーザーが自分のデータに接続できるようにするには、OAuth 標準を使用できます。
まず、Procore にOAuth アプリケーションを登録します。Developer Account にログインし、Create New App に移動することで登録できます。アプリを登録するために必要なすべてのステップに従います。まずSandbox Manifest の新しいバージョンを作成し、Production に昇格させてProduction Credentials を取得します。OAuth アプリケーションにはclient id とclient secret が割り当てられます。
以下の接続プロパティを設定すると、接続の準備が整います:
- AuthScheme:OAuth に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId:アプリ設定で指定されているclient_id を設定します。
- OAuthClientSecret:アプリ設定で指定されているclient_secret を設定します。
- CallbackURL:アプリ設定で指定されているRedirect URI を設定します。
Procore にクエリを実行
read_sql 関数を使って、padas からSQL 文を発行し、DataFrame に結果を格納します。
df = pd.read_sql("""SELECT Id, Name FROM Companies WHERE IsActive = 'true'""", 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 設定
次に、Procore のデータ をベースにした棒グラフを作詞し、アプリのレイアウトを設定します。
trace = go.Bar(x=df.Id, y=df.Name, 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='Procore Companies Data', barmode='stack')
})
], className="container")
アプリをセットアップして実行
接続、アプリ、レイアウトを定義したら、アプリを実行してみましょう。以下のコードで実行できます。
if __name__ == '__main__':
app.run_server(debug=True)
最後に、Python でウェブアプリを起動してブラウザでProcore のデータ を見てみましょう。
python api-dash.py
ちゃんとデータが表示できてますね!
おわりに
Procore Python Connector の30日の無償トライアル をぜひダウンロードして、Procore のデータ への接続をPython アプリやスクリプトから簡単に作成してみてください。