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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

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

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

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

pip install petl
pip install pandas

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

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

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

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

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

cnxn = mod.connect("InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

接続には、認証用の値に加えてSchema 接続プロパティを設定してください。Xero はプライベートアプリケーション、 パブリックアプリケーション、パートナーアプリケーションに認証を提供します。設定したアプリケーションに応じて、XeroAppAuthentication プロパティを PUBLIC、PRIVATE、またはPARTNER に設定する必要があります。プライベートアプリケーションから接続するには、追加でOAuthAccessToken、OAuthClientId、 OAuthClientSecret、CertificateStoreType、CertificateStore、およびCertificateStorePassword を設定してください。

パブリックまたはパートナーアプリケーションから接続する場合は、埋め込みOAuthClientId、OAuthClientSecret、 およびCallbackURL を指定するか、アプリを登録してOAuth の値を入手できます。

Xero への認証については、ヘルプドキュメントの「はじめに」を参照してください。

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

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

sql = "SELECT Name, QuantityOnHand FROM Items WHERE Name = 'Golf balls - white single'"

Xero データ のETL 処理

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

table1 = etl.fromdb(cnxn,sql)

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

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

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

おわりに

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

フルソースコード

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

cnxn = mod.connect("InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

sql = "SELECT Name, QuantityOnHand FROM Items WHERE Name = 'Golf balls - white single'"

table1 = etl.fromdb(cnxn,sql)

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

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