Python

PythonでRedmineを操作するための準備

PythonでRedmine

PythonでRedmineを操作することができると、効率化のアイデアがメチャクチャ広がります。

例えば…

  • チケットを一気に作成したり
  • チケットを一気に更新したり
  • 任意のチケット情報を一覧化したり

こんな感じでPythonを使う事によってRedmineを効率的に使う事が出来ます。

ただ、PythonがあればすぐにRedmineを使えるかと言うとそうではなく、ちょっとだけ準備が必要になります。

今回はその準備について解説をしていきます。

やる準備は2つだけ

  1. RedmineのAPIアクセスキーを取得すること
  2. 2つ目は各種IDを調べることです

この二つがそろって初めてPythonでRedmineを触ることができます。では早速解説してきます。

RedmineのAPIアクセスキーを調べる

APIアクセスキーは要はあなたのRedmineのIDとパスワードがセットになったコードみたいなものですね。

これをPythonに渡してあげる事により、IDとパスワードを入力せずにRedmineをいじくることができるようになります。

なのでAPIアクセスキーの取り扱いには注意してください。(どこかから、あなたのAPIアクセスキーが漏れたら、なりすましでチケットをいじることができるようになってしまいます…)

やることは簡単で、管理ボタンから設定を押して

python-redmine設定

次にAPIのタブからRESTによるWEBサービスを有効にするにチェックを入れます

python-redmine設定2

最後に個人設定からAPIを表示すれば、あなたのAPIが表示さまーす。

python-redmine設定

最初にも言いましたが、このAPIは大事なコードなので、他人には見えないように管理するようにしてください。

これで一つ目の準備は完了でーす。

Redmineの各種IDを一瞬で調べる

PythonでRedmineをいじくる際、各種IDを使って更新であったり作成をします。

わかりやすい所で言うと、トラッカーIDであったり、作成者のID、優先度のIDやあとはカスタムフィールドのIDもあったりします。

これらがわからないと、PythonでRedmineをいじるくことはできないでーす。

でもご安心あれ。これらのIDを一瞬で調べる方法があるのです。

それは、Choromeでチケット作成を開き、右クリックを押して、ページのソースを表示ボタンを押すのです。

そうするとWebページのコードがぶわぁーって出てきます。このコードの下の方に行くと、チケット作成時の選択肢が書かれているのが目につくと思います。

例えば、↓の画像だと進捗率がdone_ratioというIDというのがわかります。

python-redmine5

done_ratioの値が10がだったら、10%で20だったら20%みたいな感じになります。

実際にPythonで書く際はdone_ratio=20みたいに書くことによって、進捗率を20%に変更することが可能です。

この近辺にIDが集まっているので、別途エクセルにIDを一覧にしておくと、Pythonでコードを書く際にスムーズに取り掛かることができます。

PythonでRedmineをいじれると、重宝されるかも

私もまだ全然勉強を始めたばかりですが、PythonでRedmineを触れる人ってあんまりいないと思います。

体感的にはVBAのファイルを周りに配ったとき以上の反応がありました。

ネットにあまりサンプルが転がっていないので、手探りな感じにはなってしまいますが、ちょっとづつ勉強していこうと思います。

関連記事