From 0b7e3a81e83e492fa0413efd878ef4c61304e3ed Mon Sep 17 00:00:00 2001 From: Scriptim Date: Wed, 4 Nov 2020 00:26:13 +0100 Subject: [PATCH] Add section about optional keyring dependency --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index a1cd1dd..2113cb1 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,13 @@ The use of [venv] is recommended. The new values are: `REGULAR_FOLDER`, `VIDEO_FOLDER`, `EXERCISE_FOLDER`, `REGULAR_FILE`, `VIDEO_FILE`, `FORUM`, `EXTERNAL_LINK`. - Forums and external links are skipped automatically if you use the `kit_ilias` helper. +### Optional dependency for keyring feature + +PFERD provides a feature for optionally storing the authentication credentials in the system keyring service to make the login process more convenient. If you want to use that feature, the `keyring` package is required: +``` +$ pip install keyring +``` + ## Example setup In this example, `python3` refers to at least Python 3.8.