Welcome to python-kanbanize’s documentation!

Contents:

abstract:

Python interface to kanbanize.com API

version:

0.2.0

author:

Stefano Guandalini <guandalf@gmail.com>

contact:

http://stefanoguandalini.it/

date:

2012-04-06

copyright:

Copyright (C) 2011, Stefano Guandalini <guandalf@gmail.com>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

class python_kanbanize.wrapper.Kanbanize(apikey, **kwargs)

Specialized version of restkit.Resource to deal with kanbanize.com APIs

Parameters:apikey (str) – Your kanbanize.com API key

create_new_task(boardid, details={})

Creates a new task in ‘boardid’ board with optional ‘details’

Parameters:

• boardid (int) – Board number to retrieve tasks from
• details (dict (http://kanbanize.com/ctrl_integration for details)) – Task details

Return type:

int

get_all_tasks(boardid, format='dict')

Retireves a list of all tasks on ‘boardid’ board

Parameters:

• boardid (int) – Board number to retrieve tasks from
• format (None, ‘xml’, ‘json, ‘csv’) – Return format

Return type:

dict or str (for explicit format request)

Raises :

TypeError if given format is != from the ones above

Example:

>>> from kanbanize.wrapper import Kanbanize
>>> from credentials import *

>>> k = Kanbanize(apikey)
>>> k.get_all_tasks(5)
[{u'columnname': u'backlog', u'blockedreason': None, u'lanename': u'Default Swimlane', u'subtaskdetails': [], u'subtasks': None, u'title': u'Task title', u'color': u'#F0F0F0', u'tags': u'', u'priority': u'Average', u'assignee': u'None', u'deadline': None, u'taskid': u'38', u'subtaskscomplete': None, u'extlink': u'', u'blocked': None, u'type': u'0', u'leadtime': 1, u'size': u'2'}, {u'columnname': u'Backlog', u'blockedreason': None, u'lanename': u'Default Swimlane', u'subtaskdetails': [], u'subtasks': u'0', u'title': u'Kanbanize test task 01', u'color': u'#99b399', u'tags': None, u'priority': u'Average', u'assignee': u'None', u'deadline': None, u'taskid': u'27', u'subtaskscomplete': u'0', u'extlink': None, u'blocked': u'0', u'type': u'0', u'leadtime': 15, u'size': u'2'}, {u'columnname': u'Backlog', u'blockedreason': None, u'lanename': u'Default Swimlane', u'subtaskdetails': [], u'subtasks': u'0', u'title': u'Kanbanize test task 02', u'color': u'#99b399', u'tags': None, u'priority': u'Average', u'assignee': u'None', u'deadline': None, u'taskid': u'28', u'subtaskscomplete': u'0', u'extlink': None, u'blocked': u'0', u'type': u'0', u'leadtime': 15, u'size': u'2'}]

get_task_details(boardid, taskid, format='dict')

Retireves ‘taskid’ task details from ‘boardid’ board

Parameters:

• boardid (int) – Board number to retrieve tasks from
• taskid (int) – Id of the task to retrieve details from
• format (None, ‘xml’, ‘json, ‘csv’) – Return format

Return type:

dict or str (for explicit format request)

Raises :

TypeError if given format is != from the ones above

Indices and tables

• Index
• Module Index
• Search Page