Selaa lähdekoodia

Merge pull request #5341 from e-gaulue/e-gaulue-wiki-1

Clarify usage of api.py
Lauri Ojansivu 1 vuosi sitten
vanhempi
sitoutus
059743ad34
1 muutettua tiedostoa jossa 12 lisäystä ja 5 poistoa
  1. 12 5
      docs/wekan.wiki/New-card-with-Python3-and-REST-API.md

+ 12 - 5
docs/wekan.wiki/New-card-with-Python3-and-REST-API.md

@@ -1,4 +1,7 @@
-Also see:
+Wekan provides 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.