Python API Client for Kanboard 1.1.2を使用して、ユーザーの操作を行う

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

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

pipenv install kanboard

または

pip3 install kanboard

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

〇ユーザーの列挙

import kanboard
from pprint import pprint

apiKey = 'your-api-key'
apiEndpoint = 'your-api-endpoint'

kb = kanboard.Client(apiEndpoint, 'jsonrpc', apiKey)
users = kb.getAllUsers()
pprint(users)

〇ユーザーの追加

import kanboard
from pprint import pprint

apiKey = 'your-api-key'
apiEndpoint = 'your-api-endpoint'

kb = kanboard.Client(apiEndpoint, 'jsonrpc', apiKey)
result = kb.createUser(username="sample1", password="sample1", name="サンプル一郎", role="app-user")
pprint(result)

〇ユーザーの無効化

import kanboard
from pprint import pprint

apiKey = 'your-api-key'
apiEndpoint = 'your-api-endpoint'

kb = kanboard.Client(apiEndpoint, 'jsonrpc', apiKey)
result = kb.getUserByName(username="sample1")
userID = result['id']
result = kb.disableUser(user_id = userID)
pprint(result)

〇ユーザーの有効化

import kanboard
from pprint import pprint

apiKey = 'your-api-key'
apiEndpoint = 'your-api-endpoint'

kb = kanboard.Client(apiEndpoint, 'jsonrpc', apiKey)
result = kb.getUserByName(username="sample1")
userID = result['id']
result = kb.enableUser(user_id = userID)
pprint(result)

〇関連情報
・Python API Client for Kanboardのついてのまとめは「Python API Client for KanboardでKanboardをコントロールする」を参照してください。

・Python API Client for KanboardのGithubページ
https://github.com/kanboard/python-api-client

・Kanboardに関する他の情報はこちらを参照してください。

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