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

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

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

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

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

pip install petl
pip install pandas

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

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

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

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

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

cnxn = mod.connect("Profile=C:\profiles\Helpscout.apip;ProfileSettings='APIKey=your_api_key';")

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

Helpscout API プロファイル設定

Help Scout で Your Profile > Authentication > Generate an API Key に移動して API キーを生成します。

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

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

sql = "SELECT Id, Number FROM Categories WHERE Visibility = 'public'"

Helpscout データのETL 処理

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

table1 = etl.fromdb(cnxn,sql)

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

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

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

おわりに

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

フルソースコード

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

cnxn = mod.connect("Profile=C:\profiles\Helpscout.apip;ProfileSettings='APIKey=your_api_key';")

sql = "SELECT Id, Number FROM Categories WHERE Visibility = 'public'"

table1 = etl.fromdb(cnxn,sql)

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

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