Python でFreshBooks のデータを変換・出力するETL 処理を作る方法

加藤龍彦
加藤龍彦
デジタルマーケティング
CData Python Connector とpetl モジュールを使って、FreshBooks のデータを変換後にCSV ファイルに吐き出すETL 処理を実装します。



Pythonエコシステムには多くのモジュールがあり、システム構築を素早く効率的に行うことができます。本記事では、CData Python Connector for API とpetl フレームワークを使って、FreshBooks のデータにPython から接続してデータを変換、CSV に出力するETL 変換を実装してみます。

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

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

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

pip install petl
pip install pandas

Python でFreshBooks のデータをETL 処理するアプリを構築

モジュールとフレームワークをインストールしたら、ETL アプリケーションを組んでいきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に付いています。

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

import petl as etl
import pandas as pd
import cdata.api as mod

接続文字列で接続を確立します。connect 関数を使って、CData FreshBooks Connector からFreshBooks への接続を行います

cnxn = mod.connect("Profile=C:\profiles\FreshBooks.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH;")

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

FreshBooks API プロファイル設定

FreshBooks Developer Dashboard で OAuth アプリケーションを登録し、Client ID と Client Secret を取得します。アプリケーションのコールバック URL にリダイレクト URI を設定します。

FreshBooks をクエリするSQL 文の作成

FreshBooks にはSQL でデータアクセスが可能です。Invoices エンティティからのデータを読み出します。

sql = "SELECT Id, InvoiceNumber FROM Invoices WHERE AccountId = 'your_account_id'"

FreshBooks データのETL 処理

DataFrame に格納されたクエリ結果を使って、petl でETL(抽出・変換・ロード)パイプラインを組みます。この例では、FreshBooks のデータ を取得して、InvoiceNumber カラムでデータをソートして、CSV ファイルにデータをロードします。

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'InvoiceNumber')

etl.tocsv(table2,'invoices_data.csv')

CData Python Connector for API を使えば、データベースを扱う場合と同感覚で、FreshBooks のデータ を扱うことができ、petl のようなETL パッケージから直接データにアクセスが可能になります。

おわりに

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



フルソースコード

import petl as etl
import pandas as pd
import cdata.api as mod

cnxn = mod.connect("Profile=C:\profiles\FreshBooks.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH;")

sql = "SELECT Id, InvoiceNumber FROM Invoices WHERE AccountId = 'your_account_id'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'InvoiceNumber')

etl.tocsv(table2,'invoices_data.csv')

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

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

FreshBooks に接続