About

backloglib は Backlog の API にアクセスするための python のクライアントライブラリです。(上記ロゴの著作権は株式会社ヌーラボに帰属します)

Update

• 2010/11/06 0.2.1 をリリースしました

リリースの詳細については ReleaseNotes を参照ください。

Benefits

ライブラリを使うメリットとしては、

• Pydev などの IDE を使うと、メソッドの補完をしてくれる事
• 実際の API コールの前に、引数の名前チェックをする事 (= 引数に不足あればエラーが出ます)

といった辺りです。非常にシンプルなラッパーという位置づけです。

Install

前提条件

0.2.1 より python 2.5 以上でのご利用を前提としています。2.5 と 2.6 にて動作を確認しています。標準で提供されている xmlrpclib 以外に依存しているライブラリはありません。

setup.py を利用する場合

1. ダウンロードしたアーカイブを展開

$ tar zxvf backloglib-<ver>.tar.gz

2. setup.py を実行

$ cd backloglib-<ver>
$ python setup.py install

easy_install を利用する場合

easy_install を利用する場合は、まずお手元の環境に setuptools をインストールした後に以下を実行してください。

1. easy_install を実行

$ easy_install backloglib

How To Use

基本的な使い方は以下の 2 ステップとなります。

1. backlog オブジェクトを生成
2. API に従ったメソッド呼び出し

例としては以下のようになります。各メソッドの詳細については上記の API のページの詳細をご覧ください。backloglib で呼び出すメソッド名は、基本的に Backlog API のキャメル記法をアンダースコアに、大文字を全て小文字に置き換えたものになっています。

import backloglib

# ----- 1. backlog オブジェクトを生成 -----

backlog = backloglib.Backlog("spacename","username","password")

# ----- 2. API に従ったメソッド呼び出し -----

# プロジェクトの取得
projects = backlog.get_projects()
project = backlog.get_project("YOUR_PROJECT")
project = backlog.get_project(1) # YOUR_PROJECT's ID

# コンポーネントの取得
components = backlog.get_components(project.id)

# バージョンの取得
versions = backlog.get_versions(project.id)

# ユーザの取得
users = backlog.get_users(project.id)

# 課題タイプの取得
issue_types = backlog.get_issue_types(project.id)

# 課題の取得
issue = backlog.get_issue("ISSUE_NAME")
issue = backlog.get_issue(1) # ISSUE_NAME's ID

# コメントの取得
comments = backlog.get_comments(issue.id)

# 課題数の取得
count = backlog.count_issue({
                            "projectId":project.id
                            })

# 課題の検索
issues = backlog.find_issue({
                            "projectId":project.id
                            })

# 課題の作成
issue = backlog.create_issue({
                             "projectId":project.id,
                             "summary":u"課題のサマリ"
                             })

# 課題の更新
updated = backlog.update_issue({
                               "key":issue.key,
                               "summary":u"サマリの更新"
                               })

# ステータスの更新
updated = backlog.switch_status({
                               "key":issue.key,
                               "statusId":backloglib.Status.COMPLETED
                               })

管理者用 API (backlog.admin ではじまるもの) は以下のように BacklogAdmin オブジェクトを利用します。利用方法は上記と変わりません。

import backloglib

# ----- 1. backlog オブジェクトを生成 -----

backlog = backloglib.BacklogAdmin("spacename","username","password")

# ----- 2. API に従ったメソッド呼び出し -----

# プロジェクトユーザの取得
project_users = backlog.get_project_users()