aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorOlicorne <26625900+thiswillbeyourgithub@users.noreply.github.com>2025-05-17 17:04:56 +0200
committerGitHub <noreply@github.com>2025-05-17 16:04:56 +0100
commit60f47122b668f4c031871f49a0bbe2260060eeab (patch)
tree6b1e2fca7fb3aa75801a2cc8ba8f6a72517e35ab /docs
parent65d7096b6f4d27491856eb41cbeb67d231f7557c (diff)
downloadkarakeep-60f47122b668f4c031871f49a0bbe2260060eeab.tar.zst
doc: Mention karakeep-python-api in community projects (#1424)
* doc: mention karakeep-python-api in the community projects * doc: also mention karakeep-python-api in the cli section
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/09-command-line.md5
-rw-r--r--docs/docs/13-community-projects.md8
2 files changed, 13 insertions, 0 deletions
diff --git a/docs/docs/09-command-line.md b/docs/docs/09-command-line.md
index a7b7fc87..a86fa61e 100644
--- a/docs/docs/09-command-line.md
+++ b/docs/docs/09-command-line.md
@@ -107,3 +107,8 @@ karakeep --api-key mysupersecretkey --server-addr https://try.karakeep.app whoam
email: 'test@gmail.com'
}
```
+
+
+## Other clients
+
+There also exists a **non-official**, community-maintained, python package called [karakeep-python-api](https://github.com/thiswillbeyourgithub/karakeep_python_api) that can be accessed from the CLI, but is **not** official.
diff --git a/docs/docs/13-community-projects.md b/docs/docs/13-community-projects.md
index e2781416..79ca1e4d 100644
--- a/docs/docs/13-community-projects.md
+++ b/docs/docs/13-community-projects.md
@@ -45,3 +45,11 @@ _By [@DanSnow](https://github.com/DanSnow)_
A chrome extension that injects karakeep's bookmarks into your search results.
Get it [here](https://dansnow.github.io/hoarder-pipette/guides/installation/).
+
+### Karakeep-Python-API
+
+_By [@thiswillbeyourgithub](https://github.com/thiswillbeyourgithub/)_
+
+A python package to simplify access to the karakeep API. Can be used as a library or from the CLI. Aims for feature completeness and high test coverage but do check its feature matrix before relying too much on it.
+
+Get it [here](https://github.com/thiswillbeyourgithub/karakeep_python_api).