Redmine REST APIを操作するpython_redmineを試してみた

2017/03/05

Redmine のGUIの登録が面倒なのでコマンドで登録、更新、時間の記録が出来るようにしたい、ってことで、Redmine REST APIをPythonで扱う方法をいろいろ見てみましたが、python_redmineが必要な操作を満たしていて使い勝手が良さそうなので試してみました。

python_redmine

RedmineでREST APIを有効にする

管理者でRedmineにログインして[API]タグ-[RESTによるWebサービスを有効にする]にチェックします。
※バージョンによっては[認証]タグにあります。

API操作に使用するユーザの[個人設定]の右ペインでAPIアクセスキーをコピーして使います。

インストール

pipでインストール出来ます。

$ pip install python_redmine

1 2	$ pip install python_redmine

基本

「key=」にAPIアクセスキーを指定します。

from redmine import Redmine

redmine = Redmine('http://mydomain.com', key='xxxxxxxxxxxxxxxxxxxxxxxxxxxx')

from redmine import Redmine

redmine = Redmine('http://mydomain.com', key='xxxxxxxxxxxxxxxxxxxxxxxxxxxx')

チケット登録

手入力同様に必須でもデフォルト値のあるフィールドは省略可能です。

issue = redmine.issue.new()
issue.project_id = 'test'
issue.subject = u'題名'
issue.tracker_id = 1
issue.description = u'チケットの説明フィールド\n改行'
issue.assigned_to_id = 1
issue.start_date = datetime.date(2017, 2, 1)
issue.due_date = datetime.date(2017, 2, 28)
issue.estimated_hours = 3
issue.save()

issue = redmine.issue.new()

issue.project_id = 'test'

issue.subject = u'題名'

issue.tracker_id = 1

issue.description = u'チケットの説明フィールド\n改行'

issue.assigned_to_id = 1

issue.start_date = datetime.date(2017, 2, 1)

issue.due_date = datetime.date(2017, 2, 28)

issue.estimated_hours = 3

issue.save()

project_idはプロジェクトの識別子を指定します。

tracker_id(トラッカー) はtrackerテーブルのレコードで確認します。

assigned_to_id(担当者)はusersテーブルのレコードで確認します。

estimated_hours(予定工数)は時間です。

start_date , due_dateは厳密に日付型で指定します。

チケット更新

issue = redmine.issue.get(12345)
issue.status_id = 2
issue.due_date = datetime.date(2017, 3, 31)
issue.save()

issue = redmine.issue.get(12345)

issue.status_id = 2

issue.due_date = datetime.date(2017, 3, 31)

issue.save()

該当のチケットIDはredmine.issue.getで取得します。
このチケットIDは画面で確認出来るIDです。

よくあるケースとして、ステータス、期日を変更してみました。

作業時間の記録

time_entry = redmine.time_entry.new()
time_entry.issue_id = 12345
time_entry.spent_on = datetime.date.today()
time_entry.hours = 3
time_entry.activity_id = 12
time_entry.comments = u'作業の内容'
time_entry.save()