mirror of
https://github.com/wekan/wekan.git
synced 2026-11-05 21:44:59 -05:00
Lauri OjansivuandClaude Opus 4.8
7b66884ba3
Many docs still used flat GitHub-wiki page-name links like [Backup](Backup), [OAuth2](OAuth2) or [FAQ](FAQ) that only resolved on the old wiki; in the docs/ hierarchy they were broken. Rewrite them to correct relative paths of the existing pages (e.g. ](Backup) -> ](Backup.md), ](OAuth2) -> ](../Login/OAuth2.md), ](Sandstorm) -> ](../Platforms/FOSS/Sandstorm/Sandstorm.md)). Mapping: page name -> docs/<...>/<Name>.md by filename, with explicit handling for renamed pages (Caddy/Nginx-Webserver-Config, Wekan-Markdown, the Sandstorm grain export page, Uberspace) and the REST-API-<X> family -> docs/API/<X>.md. Ambiguous names resolved by preferring a same-directory file or the primary page. Anchors and markdown titles preserved. 280 links across the docs tree. Out of scope (left as-is): source-code references (models/*.js etc.) and [Link](url) placeholders, which are not docs pages. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
42 lines
1.3 KiB
Markdown
42 lines
1.3 KiB
Markdown
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.md#example-call---as-form-data)
|
|
- [API docs and examples for various programming languages](https://wekan.fi/api/), there is Boards / Export for exporting board with API
|
|
- In the right menu, scroll down REST API Docs etc links =====>
|
|
- Wekan-Gogs integration with Node.js https://github.com/wekan/wekan-gogs
|
|
|
|
# Install
|
|
|
|
You need python3.
|
|
|
|
Windows
|
|
```
|
|
choco install python3
|
|
# REBOOT
|
|
pip3 install pip --upgrade
|
|
pip3 install json
|
|
python3 wekan.py
|
|
```
|
|
Debian/Ubuntu
|
|
```
|
|
sudo apt-get -y install python3 python3-pip python3-simplejson
|
|
sudo pip3 install pip --upgrade
|
|
chmod +x wekan.py
|
|
./wekan.py
|
|
```
|
|
|
|
# Usage
|
|
|
|
Copy the api.py script to you machine. [Newest Wekan Python CLI api.py here](https://raw.githubusercontent.com/wekan/wekan/master/api.py).
|
|
|
|
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.
|
|
|
|
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.
|