summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2016-01-23 10:52:55 -0500
committerFrederic Guillot <fred@kanboard.net>2016-01-23 10:52:55 -0500
commit94207cf8ea41132fd7279ab08845677542eb3c9f (patch)
treef66be31beed2383e91b8fdbe527b9a77c5b1be07 /doc
parentad8fcf035ab92d8cd06179959000b9a1681b1505 (diff)
Update doc and readme
Diffstat (limited to 'doc')
-rw-r--r--doc/api-examples.markdown56
-rw-r--r--doc/faq.markdown34
2 files changed, 28 insertions, 62 deletions
diff --git a/doc/api-examples.markdown b/doc/api-examples.markdown
index 9b1ed12a..14d5db98 100644
--- a/doc/api-examples.markdown
+++ b/doc/api-examples.markdown
@@ -34,62 +34,30 @@ Response from the server:
Example with Python
-------------------
-Here a basic example written in Python to create a task:
+You can use the [official Python client for Kanboard](https://github.com/kanboard/kanboard-api-python):
-```python
-#!/usr/bin/env python
-
-import requests
-import json
-
-def main():
- url = "http://demo.kanboard.net/jsonrpc.php"
- api_key = "be4271664ca8169d32af49d8e1ec854edb0290bc3588a2e356275eab9505"
- headers = {"content-type": "application/json"}
-
- payload = {
- "method": "createTask",
- "params": {
- "title": "Python API test",
- "project_id": 1
- },
- "jsonrpc": "2.0",
- "id": 1,
- }
+```bash
+pip install kanboard
+```
- response = requests.post(
- url,
- data=json.dumps(payload),
- headers=headers,
- auth=("jsonrpc", api_key)
- )
+Here an example to create a project and a task:
- if response.status_code == 401:
- print "Authentication failed"
- else:
- result = response.json()
+```python
+from kanboard import Kanboard
- assert result["result"] == True
- assert result["jsonrpc"]
- assert result["id"] == 1
+kb = Kanboard("http://localhost/jsonrpc.php", "jsonrpc", "your_api_token")
- print "Task created successfully!"
+project_id = kb.create_project(name="My project")
-if __name__ == "__main__":
- main()
+task_id = kb.create_task(project_id=project_id, title="My task title")
```
-Run this script from your terminal:
-
-```bash
-python jsonrpc.py
-Task created successfully!
-```
+There are more examples on the [official website](https://github.com/kanboard/kanboard-api-python).
Example with a PHP client
-------------------------
-I wrote a simple [Json-RPC Client/Server library in PHP](https://github.com/fguillot/JsonRPC), here an example:
+You can use this [Json-RPC Client/Server library for PHP](https://github.com/fguillot/JsonRPC), here an example:
```php
<?php
diff --git a/doc/faq.markdown b/doc/faq.markdown
index de7c9801..953f98e1 100644
--- a/doc/faq.markdown
+++ b/doc/faq.markdown
@@ -10,18 +10,18 @@ Kanboard works well with any great VPS hosting provider such as [Digital Ocean](
To have the best performances, choose a provider with fast disk I/O because Kanboard use Sqlite by default.
Avoid hosting providers that use a shared NFS mount point.
+
I get a blank page after installing or upgrading Kanboard
---------------------------------------------------------
- Check if you have installed all requirements on your server
+- Check the PHP and Apache error logs
- Check if the files have the correct permission
-- If you use php-fpm and opcode caching, reload the process to be sure to clear the cache
-- Enable PHP error logging in your php.ini
-- Check the PHP and Apache error logs you should see the exact error
+- If you use an aggressive OPcode caching, reload your web-server or php-fpm
Page not found and the URL seems wrong (&amp;amp;)
-----------------------------------------------
+--------------------------------------------------
- The URL looks like `/?controller=auth&amp;action=login&amp;redirect_query=` instead of `?controller=auth&action=login&redirect_query=`
- Kanboard returns a "Page not found" error
@@ -85,20 +85,6 @@ open http://localhost:8000/
```
-How to migrate my tasks from Wunderlist?
-----------------------------------------
-
-You can use an external tool to import your tasks automatically and lists from Wunderlist to Kanboard.
-
-This is a command line script made by a contributor of Kanboard.
-It's simple, quick and dirty but it works :)
-
-More information here:
-
-- [Wunderlist](http://www.wunderlist.com/)
-- <https://github.com/EpocDotFr/WunderlistToKanboard>
-
-
How to install Kanboard on Yunohost?
------------------------------------
@@ -107,6 +93,18 @@ How to install Kanboard on Yunohost?
There is a [package to install Kanboard on Yunohost easily](https://github.com/mbugeia/kanboard_ynh).
+Where can I find a list of related projects?
+--------------------------------------------
+
+- [Kanboard API python client by @freekoder](https://github.com/freekoder/kanboard-py)
+- [Kanboard Presenter by David Eberlein](https://github.com/davideberlein/kanboard-presenter)
+- [CSV2Kanboard by @ashbike](https://github.com/ashbike/csv2kanboard)
+- [Kanboard for Yunohost by @mbugeia](https://github.com/mbugeia/kanboard_ynh)
+- [Trello import script by @matueranet](https://github.com/matueranet/kanboard-import-trello)
+- [Chrome extension by Timo](https://chrome.google.com/webstore/detail/kanboard-quickmenu/akjbeplnnihghabpgcfmfhfmifjljneh?utm_source=chrome-ntp-icon), [Source code](https://github.com/BlueTeck/kanboard_chrome_extension)
+- [Python client script by @dzudek](https://gist.github.com/fguillot/84c70d4928eb1e0cb374)
+
+
Are there some tutorials about Kanboard in other languages?
-----------------------------------------------------------