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

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムFreshBooks data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。FreshBooks に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接FreshBooks 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います（特にJOIN やSQL 関数など）。

FreshBooks への接続

FreshBooks data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

FreshBooks はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。

詳細はヘルプドキュメントの「はじめに」を参照してください。

以下の手順に従い、必要なモジュールをインストールし、Python オブジェクト経由でFreshBooks にアクセスします。

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

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

pip install pandas
pip install dash
pip install dash-daq

Python でFreshBooks データ をビジュアライズ

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

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

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

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

cnxn = mod.connect("CompanyName=CData;Token=token;")

FreshBooks にクエリを実行

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

df = pd.read_sql("""SELECT Username, Credit FROM Clients WHERE Email = 'Captain Hook'""", cnxn)

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

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

app_name = 'dash-freshbooksedataplot'

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

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

Layout 設定

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

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

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

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

接続、アプリ、レイアウトを定義したら、アプリを実行してみましょう。Python コードの最後はこのようです。

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

では、Python でウェブアプリを稼働させて、ブラウザでFreshBooks data を見てみましょう。

python freshbooks-dash.py

製品の無償トライアル情報

FreshBooks Python Connector の30日の無償トライアル をぜひダウンロードして、FreshBooks data への接続をPython アプリやスクリプトから簡単に作成しましょう。

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

cnxn = mod.connect("CompanyName=CData;Token=token;")

df = pd.read_sql("SELECT Username, Credit FROM Clients WHERE Email = 'Captain Hook'", cnxn)
app_name = 'dash-freshbooksdataplot'

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

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

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