growing hard days.

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

2017/03/05

Redmine のGUIの登録が面倒なのでコマンドで登録、更新、時間の記録が出来るようにしたい、ってことで、Redmine REST APIをPythonで扱う方法をいろいろ見てみましたが、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')

1

2

3

4

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()

1

2

3

4

5

6

7

8

9

10

11

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()

1

2

3

4

5

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()

1

2

3

4

5

6

7

8

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()

activity_id(作業種別)は事前に確認しておきます。

spent_on(作業日)は厳密に日付型なので、datetime.today()ではなくdate.today()を使います。

issue_idにチケットIDを指定します。

今後

Slackからの操作を予定しているので、各IDとかを検索できるコマンドも用意しないと、コマンドだけでは完結しないので、そのへんも作ろうと思います。

開発ベンダー5年、ユーザ企業システム部門通算9年、ITトレーナー2年目のSoftware Engineerです。
質問はコメントかSNSなどからお気軽にどうぞ。
出来る限りなるべく答えます。

このブログの内容/発言の一切は個人の見解であり、所属する組織とは関係ありません。

また、勉強会やイベントのレポートは自分が気になったことをメモしたり、聞いて思ったことを書いていますので、登壇者の意見や発表内容ではありません。

- ProjectManagement, Python, Redmine python, Redmine

Tweet

関連記事

: Redmine3.0.0に CSV Importerプラグインをインストールする

バグ管理や開発の現場だけではなく進捗管理などにも重宝出来るRedmine。その …

: pythonのsqlalchemyで嵌った話

エラーメッセージ InvalidRequestError: SQL expres …

: Pandoc PDF出力時に目次とヘッダをつける

目次をつける環境などはPandoc関連記事をご確認ください。 Pandoc実行 …

: Python openpyxlで結合セルを含むExcelファイルを開くと罫線が消える

PythonのExcelを読み書きするためのライブラリ、openpyxlで結合セ …

: Redmine 3.4にAgile Plugin をインストール

過去にも似たような記事を書いていますが、新しいバージョンのRedmine 3.4 …

: 「大阪Pythonユーザの集まり」に行ってきました

「大阪Pythonユーザの集まり」に行ってきました。あんまりメモ取れてません …

: CentOS 6.5にgit連携のTracを構築する

秋の夜長に自宅でTracサーバを構築してみる。ひとまずRedmineはいったん …

: CentOS 6.5にRedmineをインストールするためにrubyをインストールする

とりあえずgitは入っている前提で [crayon-5c3ee616778069 …

: Tracの外観をプラグインで変更する-TracpathThemeプラグイン

プラグインをインストールするだけで外観を変更するこんな感じのUIで5色(Red …

: Python SQLAlchemy MySQLでテーブルを指定せずにFunctionを使う

難しく考えて悩んでいましたが、queryに書いてやればいいだけでした。 sess …

PREV: RedmineにEasy Gantt プラグインをインストールしようとしたらRubyのバージョンが古いという事にひっかかったのでRubyもアップグレードした
NEXT: 「JAWS-UG大阪第18回勉強会サーバーレス」の運営をしました