==============================
Python API Client for Kanboard
==============================
Client library for Kanboard API.
- Author: Frédéric Guillot
- License: MIT
Installation
============
.. code-block:: bash
python3 -m pip install kanboard
This 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:
.. code-block:: bash
dnf install python3-kanboard
Examples
========
Methods and arguments are the same as the JSON-RPC procedures described in the
`official documentation <https://docs.kanboard.org/v1/api/>`_.
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
---------------------------
.. code-block:: python
import kanboard
kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
project_id = kb.create_project(name='My project')
Authenticate as user
--------------------
.. code-block:: python
import kanboard
kb = kanboard.Client('http://localhost/jsonrpc.php', 'admin', 'secret')
kb.get_my_projects()
Create a new task
-----------------
.. code-block:: python
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')
Use a personalized user agent
-----------------------------
.. code-block:: python
import kanboard
kb = kanboard.Client(url='http://localhost/jsonrpc.php',
username='admin',
password='secret',
user_agent='My Kanboard client')
SSL connection and self-signed certificates
===========================================
Example with a valid certificate:
.. code-block:: python
import kanboard
kb = kanboard.Client('https://example.org/jsonrpc.php', 'admin', 'secret')
kb.get_my_projects()
Example with a custom certificate:
.. code-block:: python
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:
.. code-block:: python
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:
.. code-block:: python
import kanboard
kb = kanboard.Client(url='https://example.org/jsonrpc.php',
username='admin',
password='secret',
insecure=True)
kb.get_my_projects()
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.
.. code-block:: python
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'))
.. code-block:: python
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 <https://docs.kanboard.org/v1/api/>`_ for the complete list of
methods and arguments.
Raw data
{
"_id": null,
"home_page": "https://github.com/kanboard/python-api-client",
"name": "kanboard",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "kanboard api client",
"author": "Frederic Guillot",
"author_email": "fred@kanboard.net",
"download_url": "https://files.pythonhosted.org/packages/4c/01/cc8d67d9867680bec3c72d9c9d575ed22aa797d6d187ab33cdefce7b01ad/kanboard-1.1.5.tar.gz",
"platform": null,
"description": "==============================\nPython API Client for Kanboard\n==============================\n\nClient library for Kanboard API.\n\n- Author: Fr\u00e9d\u00e9ric Guillot\n- License: MIT\n\nInstallation\n============\n\n.. code-block:: bash\n\n python3 -m pip install kanboard\n\n\nThis library is compatible with Python >= 3.5.\n\nNote: **Support for Python 2.7 has been dropped since version 1.1.0.**\n\nOn Fedora (36 and later), you can install the package using DNF:\n\n.. code-block:: bash\n\n dnf install python3-kanboard\n\n\nExamples\n========\n\nMethods and arguments are the same as the JSON-RPC procedures described in the\n`official documentation <https://docs.kanboard.org/v1/api/>`_.\n\nPython methods are dynamically mapped to the API procedures: **You must use named arguments**.\n\nBy default, calls are made synchronously, meaning that they will block the program until completed.\n\nCreating a new team project\n---------------------------\n\n.. code-block:: python\n\n import kanboard\n\n kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')\n project_id = kb.create_project(name='My project')\n\n\nAuthenticate as user\n--------------------\n\n.. code-block:: python\n\n import kanboard\n\n kb = kanboard.Client('http://localhost/jsonrpc.php', 'admin', 'secret')\n kb.get_my_projects()\n\nCreate a new task\n-----------------\n\n.. code-block:: python\n\n import kanboard\n\n kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')\n project_id = kb.create_project(name='My project')\n task_id = kb.create_task(project_id=project_id, title='My task title')\n\nUse a personalized user agent\n-----------------------------\n\n.. code-block:: python\n\n import kanboard\n\n kb = kanboard.Client(url='http://localhost/jsonrpc.php',\n username='admin',\n password='secret',\n user_agent='My Kanboard client')\n\nSSL connection and self-signed certificates\n===========================================\n\nExample with a valid certificate:\n\n.. code-block:: python\n\n import kanboard\n\n kb = kanboard.Client('https://example.org/jsonrpc.php', 'admin', 'secret')\n kb.get_my_projects()\n\nExample with a custom certificate:\n\n.. code-block:: python\n\n import kanboard\n\n kb = kanboard.Client(url='https://example.org/jsonrpc.php',\n username='admin',\n password='secret',\n cafile='/path/to/my/cert.pem')\n kb.get_my_projects()\n\nExample with a custom certificate and hostname mismatch:\n\n.. code-block:: python\n\n import kanboard\n\n kb = kanboard.Client(url='https://example.org/jsonrpc.php',\n username='admin',\n password='secret',\n cafile='/path/to/my/cert.pem',\n ignore_hostname_verification=True)\n kb.get_my_projects()\n\nIgnore invalid/expired certificates and hostname mismatches, which will make your application vulnerable to man-in-the-middle (MitM) attacks:\n\n.. code-block:: python\n\n import kanboard\n\n kb = kanboard.Client(url='https://example.org/jsonrpc.php',\n username='admin',\n password='secret',\n insecure=True)\n kb.get_my_projects()\n\nAsynchronous I/O\n================\n\nThe client also exposes async/await style method calls. Similarly to the synchronous calls (see above),\nthe method names are mapped to the API methods.\n\nTo invoke an asynchronous call, the method name must be appended with ``_async``. For example, a synchronous call\nto ``create_project`` can be made asynchronous by calling ``create_project_async`` instead.\n\n.. code-block:: python\n\n import asyncio\n import kanboard\n\n kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')\n\n loop = asyncio.get_event_loop()\n project_id = loop.run_until_complete(kb.create_project_async(name='My project'))\n\n\n.. code-block:: python\n\n import asyncio\n import kanboard\n\n async def call_within_function():\n kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')\n return await kb.create_project_async(name='My project')\n\n loop = asyncio.get_event_loop()\n project_id = loop.run_until_complete(call_within_function())\n\n\nSee the `official API documentation <https://docs.kanboard.org/v1/api/>`_ for the complete list of\nmethods and arguments.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Client library for Kanboard",
"version": "1.1.5",
"split_keywords": [
"kanboard",
"api",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c63be540e4973f0d26289ea2d5d24354280547f92b389da354462a61efe576ec",
"md5": "ead76f9d75df8207491899c41904d0fa",
"sha256": "2eafd47dc4638a1226d9516dd10cea3621da4c058d28bcd7b232040213a9f5d3"
},
"downloads": -1,
"filename": "kanboard-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ead76f9d75df8207491899c41904d0fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5651,
"upload_time": "2023-02-12T00:48:03",
"upload_time_iso_8601": "2023-02-12T00:48:03.404815Z",
"url": "https://files.pythonhosted.org/packages/c6/3b/e540e4973f0d26289ea2d5d24354280547f92b389da354462a61efe576ec/kanboard-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4c01cc8d67d9867680bec3c72d9c9d575ed22aa797d6d187ab33cdefce7b01ad",
"md5": "d6bb44ca92dfbf99ad3d07af75932111",
"sha256": "5482c50cb1d83ea531f834e4dfe8c41774baacb2f465303b4920d72371361440"
},
"downloads": -1,
"filename": "kanboard-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "d6bb44ca92dfbf99ad3d07af75932111",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5360,
"upload_time": "2023-02-12T00:48:05",
"upload_time_iso_8601": "2023-02-12T00:48:05.126526Z",
"url": "https://files.pythonhosted.org/packages/4c/01/cc8d67d9867680bec3c72d9c9d575ed22aa797d6d187ab33cdefce7b01ad/kanboard-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-12 00:48:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "kanboard",
"github_project": "python-api-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kanboard"
}
JSON
