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

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

CData Python Connectors の特徴

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

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

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

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

pip install pandas
pip install dash
pip install dash-daq

Python でTickspot のデータを可視化

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

まず、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 Tickspot Connector からTickspot のデータ との接続を確立します。

cnxn = mod.connect("Profile=C:\profiles\Tickspot.apip;ProfileSettings='APIKey=your_api_key;SubscriptionId=your_subscription_id';")

まず、Profile 接続プロパティをディスク上の Tickspot プロファイルの場所に設定します（例：C:\profiles\Tickspot.apip）。次に、ProfileSettings 接続プロパティを Tickspot の接続文字列に設定します（以下を参照）。

Tickspot API プロファイル設定

Tickspot のログインメールアドレスとパスワードを使って Roles テーブルをクエリし、API Token と Subscription ID を取得します。以降のすべてのリクエストでは、返された APIKey と SubscriptionId を使用します。

Tickspot にクエリを実行

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

df = pd.read_sql("""SELECT Id, Name FROM Clients WHERE Archive = 'false'""", 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 設定

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

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

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

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

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

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

python api-dash.py

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

おわりに

Tickspot Python Connector の30日の無償トライアル をぜひダウンロードして、Tickspot のデータ への接続を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\Tickspot.apip;ProfileSettings='APIKey=your_api_key;SubscriptionId=your_subscription_id';")

df = pd.read_sql("SELECT Id, Name FROM Clients WHERE Archive = 'false'", 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.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='Tickspot Clients Data', barmode='stack')
		})
], className="container")

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