Python API Client for Kanboardを使用して、プロジェクト列の操作を行う

より新しい記事「Python API Client for Kanboard 1.1.2を使用して、プロジェクト列の操作を行う」を参照してください。

Python API Client for Kanboardを使用してPythonからKanboardを操作する事ができます。

〇Python API Client for Kanboardのインストール

pipenv install kanboard

または

pip install kanboard

〇下準備
API KeyとAPI endpointの情報はSettings > APIで取得できます
以下のサンプルコードでapiKey、apiEndpointの値に設定します。

〇プロジェクト列の列挙

from kanboard import Kanboard
from pprint import pprint

apiKey = 'your-api-key'
apiEndpoint = 'your-api-endpoint'
kb = Kanboard(apiEndpoint, 'jsonrpc', apiKey)
result = kb.getProjectByName(name="サンプルプロジェクト")
projectID = result['id']

columns = kb.getColumns(project_id=projectID)
for column in columns:
  print(str(column['id']) + ":" +  column['title'])

〇プロジェクト列の追加

from kanboard import Kanboard
from pprint import pprint

apiKey = 'your-api-key'
apiEndpoint = 'your-api-endpoint'
kb = Kanboard(apiEndpoint, 'jsonrpc', apiKey)
result = kb.getProjectByName(name="テストプロジェクト")
projectID = result['id']

kb.addColumn(project_id=projectID, title="Review")

〇プロジェクト列の削除

from kanboard import Kanboard
from pprint import pprint

apiKey = 'your-api-key'
apiEndpoint = 'your-api-endpoint'
kb = Kanboard(apiEndpoint, 'jsonrpc', apiKey)
result = kb.getProjectByName(name="テストプロジェクト")
projectID = result['id']

colname = "Review"
columns = kb.getColumns(project_id=projectID)
for column in columns:
  if column['title'] == colname:
    kb.removeColumn(column_id=column['id'])

〇関連情報
Python API Client for KanboardのGithubページ https://github.com/kanboard/python-api-client
・Kanboardに関する他の記事はこちらを参照してください。

・Kanboardのgithubリポジトリ
https://github.com/kanboard/kanboard