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

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

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

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

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

pip install petl
pip install pandas

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

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

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

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

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

cnxn = mod.connect("Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';")

API キー認証の設定

CircleCI は、API リクエストの認証にパーソナル API トークンを使用します。パーソナル API トークンを生成するには、CircleCI アカウントにログインし、User Settings > Personal API Tokens に移動して、Create New Token をクリックします。トークンの値は一度しか表示されないため、すぐにコピーしてください。

以下の接続プロパティを設定して接続を確立してください：

• AuthScheme：APIKey に設定します。
• APIKey：CircleCI のパーソナル API トークンに設定します。

接続文字列の例：

Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';

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

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

sql = "SELECT ,  FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'"

CircleCI データのETL 処理

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

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'')

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

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

おわりに

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

フルソースコード

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

cnxn = mod.connect("Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';")

sql = "SELECT ,  FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'')

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