製品をチェック

無償トライアル:

無償トライアルへ

製品の情報と無償トライアルへ:

Backlog Python Connector

Backlog へのデータ連携用のPython Connector ライブラリ。Pandas、SQLAlchemy、Dash、petl などの主要なPython ツールにBacklog をシームレスに統合。

Python のDash ライブラリを使って、Backlog データ に連携するウェブアプリケーションを開発


CData Python Connector for Backlog を使って、Backlog にデータ連携するPython ウェブアプリケーションを開発できます。pandas とDash を使って作成してみます。


古川えりか
コンテンツスペシャリスト

backlog ロゴ画像

Python

python ロゴ画像
Python ロゴ画像

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Backlog を使うことで、pandas モジュールとDash フレームワークでBacklog にデータ連携するアプリケーションを効率的に開発することができます。本記事では、pandas、Dash とCData Connector を使って、Backlog に連携して、Backlog data をビジュアライズするシンプルなウエブアプリを作ります。

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムBacklog data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。Backlog に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接Backlog 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います(特にJOIN やSQL 関数など)。

Backlog への接続

Backlog data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

API キー認証

ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには:

  1. Backlog の個人設定ページを開きます。
  2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
  3. ApiKey にAPI キーを指定します。
  4. URL はBacklog のテナントURL から取得できます。

OAuth 認証

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。

以下の手順に従い、必要なモジュールをインストールし、Python オブジェクト経由でBacklog にアクセスします。

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

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

pip install pandas
pip install dash
pip install dash-daq

Python でBacklog データ をビジュアライズ

必要なモジュールとフレームワークがインストールされたら、ウェブアプリを開発していきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に付いています。

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

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.backlog as mod
import plotly.graph_objs as go

接続文字列を使ってデータへの接続を確立します。connect 関数を使ってCData Backlog Connector にBacklog data との接続を確立します。

cnxn = mod.connect("ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;")

Backlog にクエリを実行

read_sql 関数を使って、padas からSQL 文を発行し、DataFrame に結果を格納します。

df = pd.read_sql("""SELECT Id, ProjectID FROM Issues WHERE Id = '1'""", cnxn)

ウェブアプリケーションの設定

DataFrame に格納されたクエリ結果を使って、ウェブアプリにname、stylesheet、title を設定していきます。

app_name = 'dash-backlogedataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'

Layout 設定

次に、Backlog data をベースにした棒グラフを作詞し、アプリのレイアウトを設定します。

trace = go.Bar(x=df.Id, y=df.ProjectID, name='Id')

app.layout = html.Div(children=[html.H1("CData Extention + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(alt='Backlog Issues Data', barmode='stack')
		})
], className="container")

アプリをセットアップして、実行n

接続、アプリ、レイアウトを定義したら、アプリを実行してみましょう。Python コードの最後はこのようです。

if __name__ == '__main__':
    app.run_server(debug=True)

では、Python でウェブアプリを稼働させて、ブラウザでBacklog data を見てみましょう。

python backlog-dash.py
Backlog data in a Dash web app (Salesforce is shown).

製品の無償トライアル情報

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



import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.backlog as mod
import plotly.graph_objs as go

cnxn = mod.connect("ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;")

df = pd.read_sql("SELECT Id, ProjectID FROM Issues WHERE Id = '1'", cnxn)
app_name = 'dash-backlogdataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'
trace = go.Bar(x=df.Id, y=df.ProjectID, name='Id')

app.layout = html.Div(children=[html.H1("CData Extention + Dash", style={'textAlign': 'center'}),
	dcc.Graph(
		id='example-graph',
		figure={
			'data': [trace],
			'layout':
			go.Layout(alt='Backlog Issues Data', barmode='stack')
		})
], className="container")

if __name__ == '__main__':
    app.run_server(debug=True)