Metadata-Version: 2.1
Name: kanboard
Version: 1.0.1
Summary: Kanboard API client
Home-page: https://github.com/kanboard/kanboard-api-python
Author: Frédéric Guillot
Author-email: fred@kanboard.net
License: MIT
Keywords: kanboard,api
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
License-File: LICENSE
License-File: AUTHORS

==============================
Python API Client for Kanboard
==============================

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

Minimalist Kanboard Python client.

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

Installation
============

.. code-block:: bash

    pip install kanboard


This library is compatible with Python 2.7, Python 3.4 and 3.5.

Examples
========

The methods and arguments are the same as the JSON-RPC procedures described in the `official documentation <http://kanboard.net/documentation/api-json-rpc>`_.

Python methods are dynamically mapped to the API procedures. You must use named arguments.

Create a new team project
-------------------------

.. code-block:: python

    from kanboard import Kanboard

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


Authenticate as user
--------------------

.. code-block:: python

    from kanboard import Kanboard

    kb = Kanboard('http://localhost/jsonrpc.php', 'admin', 'admin')
    kb.get_my_projects()

Create a new task
-----------------

.. code-block:: python

    from kanboard import Kanboard

    kb = Kanboard('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')

See the `official API documentation <https://kanboard.net/documentation/api-json-rpc>`_ for the complete list of methods and arguments.



