Python で Redmine RestAPI をコントロール ~インストールと設定~

準備

  • Python 3.6.1
  • "python-redmine"モジュール

インストール

実施環境に、 virtualenv を用いる詳細はここを参照

pip install python-redmine

Redmine でRestAPIを有効にする

管理画面上で"Rest API"の有効チェックボックスをオンにして保存する

Python から Redmineサーバー へのつなぎこみ

Python へ "Python-Redmine" をimportすることでRedmineサーバーへのアクセス準備が整う

from redminelib import Redmine

Redmineサーバーへの繋ぎこみ

redmine = Redmine('https://redmineserver.url')

RedmineサーバーのURLを入力するだけで繋ぎこみは完了!!

Redmine サーバーへの認証

Rest API を用いるためには認証作業が必要
2通りの方法がある

  1. ID, Password
  2. API key
# ID, Pass
redmine = Redmine('https://redmine.url', username='name', password='pass')

# API key
redmine = Redmine('https://redmine.url', key='xxxxxx')

API key はRedmineページにログインして、個人の管理ページ右側ペインボタンをタップすると表示される

Django との親和性

Redmineサーバーへの繋ぎこみの為にコード上に、ID/PassやAPI keyを記述しておくことは推奨しない。例えばDjangoのようなフレームワークを用いた場合、Python-Redminesettings.pyファイルに記述しておくことを推奨する

# settings.py
REDMINE_URL = 'https://redmine.url'
REDMINE_KEY = 'xxxxxxxxxx'
# コード内
from django.conf import settings
from redminelib import Redmine

redmine = Redmine(settings.REDMINE_URL, key=settings.REDMINE_KEY)

次回は、Python-Redmine を用いて関数の使い方をまとめる