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

加藤龍彦
加藤龍彦
デジタルマーケティング
Canny × Python連携を簡単に。pandas・DashとCData Python ConnectorでPythonのデータ連携を簡単に実現、データ可視化アプリが短時間で完成。



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

CData Python Connectors の特徴

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

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

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

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

pip install pandas
pip install dash
pip install dash-daq

Python でCanny のデータを可視化

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

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

cnxn = mod.connect("Profile=C:\profiles\Canny.apip;ProfileSettings='APIKey=your-canny-api-key';")

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

Canny API プロファイル設定

Canny では、シークレット API キーで API へのアクセスを制御します。API キーは、Canny API エンドポイントへのすべての HTTP POST リクエストで、'apiKey' という名前の JSON ボディパラメータとして送信されます。

Canny API で認証するには、会社単位のシークレット API キーが必要です。このキーは、Canny アカウントの「Settings」>「API」で確認できます。

以下の接続プロパティを設定すると、接続できるようになります。

  • AuthScheme：APIKey に設定します。
  • APIKey：Canny ダッシュボードの「Settings」>「API」ページで確認できる、会社単位のシークレット API キーに設定します。

Canny にクエリを実行

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

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

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

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

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

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

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

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

python api-dash.py
Dash のウェブアプリでCanny のデータ を表示

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

おわりに

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

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

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

はじめる準備はできましたか？

API Driver で Canny のライブデータに接続

Canny に接続

この記事の内容

関連記事