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

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

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

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

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

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

pip install petl
pip install pandas

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

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

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

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

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

cnxn = mod.connect("Profile=freee.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。

次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。

• AuthScheme：OAuth に設定します。
• OAuthClientID：アプリ設定で指定されたOAuth クライアントID に設定します。
• OAuthClientSecret：アプリ設定で指定されたOAuth クライアントシークレットに設定します。
• CallbackURL：アプリ設定で指定したリダイレクトURI に設定します。
• InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。

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

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

sql = "SELECT Amount, IssueDate FROM Deals WHERE Id = '1'"

freee データ のETL 処理

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

table1 = etl.fromdb(cnxn,sql)

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

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

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

おわりに

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

フルソースコード

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

cnxn = mod.connect("Profile=freee.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

sql = "SELECT Amount, IssueDate FROM Deals WHERE Id = '1'"

table1 = etl.fromdb(cnxn,sql)

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

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