From b6f22712f9e38a0acc10a04a167f19a2e64295bc Mon Sep 17 00:00:00 2001 From: e-gaulue Date: Mon, 11 Mar 2024 14:14:42 +0100 Subject: [PATCH] Update New-card-with-Python3-and-REST-API.md Clarify usage, at least for me. --- .../New-card-with-Python3-and-REST-API.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/wekan.wiki/New-card-with-Python3-and-REST-API.md b/docs/wekan.wiki/New-card-with-Python3-and-REST-API.md index 1016cae0d..11beb96af 100644 --- a/docs/wekan.wiki/New-card-with-Python3-and-REST-API.md +++ b/docs/wekan.wiki/New-card-with-Python3-and-REST-API.md @@ -1,4 +1,7 @@ -Also see: +Wekan provide a python script to ease the call of the REST API from command line interface. + +# Context + - [API Login to get Bearer token](REST-API#example-call---as-form-data) - [API docs and examples for various programming languages](https://wekan.github.io/api/), there is Boards / Export for exporting board with API - In the right menu, scroll down REST API Docs etc links =====> @@ -6,6 +9,8 @@ Also see: # Install +You need python3. + Windows ``` choco install python3 @@ -22,13 +27,15 @@ chmod +x wekan.py ./wekan.py ``` -# api.py creating new card with Python3 and REST API +# Usage -Below code works now, fixed at 2020-10-29. +Copy the api.py script to you machine. [Newest Wekan Python CLI api.py here](https://raw.githubusercontent.com/wekan/wekan/master/api.py). -Change these: +Then, in this script, look for and change: - wekanurl: https://boards.example.com => Your Wekan URL - username (could be username or username@example.com) - Only works with password login admin user. Does not work with LDAP, OAuth2 etc. -[Newest Wekan Python CLI api.py here](https://raw.githubusercontent.com/wekan/wekan/master/api.py) +Keep in mind your Wekan credentials are potentially accessible in this file. + +Then call it without any argument to see if everything is all right. You should just get usage examples.