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

加藤龍彦
加藤龍彦
デジタルマーケティング
CData Python Connector とpetl モジュールを使って、freee人事労務 のデータを変換後にCSV ファイルに吐き出す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=freeehr.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;")

まずは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 でデータアクセスが可能です。Employees エンティティからのデータを読み出します。 

sql = "SELECT Id, DisplayName FROM Employees WHERE Id = '1'"

freee人事労務 データのETL 処理

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

table1 = etl.fromdb(cnxn,sql)

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

etl.tocsv(table2,'employees_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=freeehr.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;")

sql = "SELECT Id, DisplayName FROM Employees WHERE Id = '1'"

table1 = etl.fromdb(cnxn,sql)

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

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

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

API Driver で freee人事労務 のライブデータに接続

freee人事労務 に接続

この記事の内容

関連記事