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

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

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

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

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

pip install petl
pip install pandas

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

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

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

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

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

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

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

CapsuleCRM API プロファイル設定

GitHub の認証情報を使用して https://developer.capsulecrm.com/signIn で OAuth アプリケーションを登録し、クライアント ID とクライアントシークレットを取得します。

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

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

sql = "SELECT Id, Name FROM ActivityTypes WHERE Name = 'Phone Call'"

CapsuleCRM データのETL 処理

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

table1 = etl.fromdb(cnxn,sql)

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

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

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

おわりに

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

フルソースコード

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

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

sql = "SELECT Id, Name FROM ActivityTypes WHERE Name = 'Phone Call'"

table1 = etl.fromdb(cnxn,sql)

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

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