Client library for Kanboard API.
- Author: Frédéric Guillot
- License: MIT
python3 -m pip install kanboardThis library is compatible with Python >= 3.5.
Note: Support for Python 2.7 has been dropped since version 1.1.0.
On Fedora (36 and later), you can install the package using DNF:
dnf install python3-kanboardMethods and arguments are the same as the JSON-RPC procedures described in the official documentation.
Python methods are dynamically mapped to the API procedures: You must use named arguments.
By default, calls are made synchronously, meaning that they will block the program until completed.
import kanboard
kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
project_id = kb.create_project(name='My project')import kanboard
kb = kanboard.Client('http://localhost/jsonrpc.php', 'admin', 'secret')
kb.get_my_projects()import kanboard
kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
project_id = kb.create_project(name='My project')
task_id = kb.create_task(project_id=project_id, title='My task title')import kanboard
kb = kanboard.Client(url='http://localhost/jsonrpc.php',
username='admin',
password='secret',
user_agent='My Kanboard client')Example with a valid certificate:
import kanboard
kb = kanboard.Client('https://example.org/jsonrpc.php', 'admin', 'secret')
kb.get_my_projects()Example with a custom certificate:
import kanboard
kb = kanboard.Client(url='https://example.org/jsonrpc.php',
username='admin',
password='secret',
cafile='/path/to/my/cert.pem')
kb.get_my_projects()Example with a custom certificate and hostname mismatch:
import kanboard
kb = kanboard.Client(url='https://example.org/jsonrpc.php',
username='admin',
password='secret',
cafile='/path/to/my/cert.pem',
ignore_hostname_verification=True)
kb.get_my_projects()Ignore invalid/expired certificates and hostname mismatches, which will make your application vulnerable to man-in-the-middle (MitM) attacks:
import kanboard
kb = kanboard.Client(url='https://example.org/jsonrpc.php',
username='admin',
password='secret',
insecure=True)
kb.get_my_projects()The client also exposes async/await style method calls. Similarly to the synchronous calls (see above), the method names are mapped to the API methods.
To invoke an asynchronous call, the method name must be appended with _async. For example, a synchronous call
to create_project can be made asynchronous by calling create_project_async instead.
import asyncio
import kanboard
kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
loop = asyncio.get_event_loop()
project_id = loop.run_until_complete(kb.create_project_async(name='My project'))import asyncio
import kanboard
async def call_within_function():
kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
return await kb.create_project_async(name='My project')
loop = asyncio.get_event_loop()
project_id = loop.run_until_complete(call_within_function())See the official API documentation for the complete list of methods and arguments.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent