Skip to content
Python API Client for Kanboard
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Adds support for async/await API calls (no deps) Jul 30, 2019
.travis.yml Simplify client class Jul 30, 2019
LICENSE Improve tests Mar 26, 2019
MANIFEST.in
README.rst Fix typo in async example Jul 30, 2019
kanboard.py Simplify client class Jul 30, 2019
setup.py Fix mistake in package name Jul 30, 2019
test_kanboard.py Simplify client class Jul 30, 2019

README.rst

Python API Client for Kanboard

https://travis-ci.org/kanboard/python-api-client.svg?branch=master

Client library for Kanboard API.

  • Author: Frédéric Guillot
  • License: MIT

Installation

pip install kanboard

This library is compatible with Python >= 3.5.

Note: Support for Python 2.7 has been dropped from version 1.1.0.

Examples

Methods 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.

Creating a new team project

import kanboard

kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
project_id = kb.create_project(name='My project')

Authenticate as user

import kanboard

kb = kanboard.Client('http://localhost/jsonrpc.php', 'admin', 'secret')
kb.get_my_projects()

Create a new task

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')

Asynchronous I/O

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.

You can’t perform that action at this time.