From a48060a9a5be75899f3729b39650c177e76d723c Mon Sep 17 00:00:00 2001 From: FliegendeWurst <2012gdwu+github@posteo.de> Date: Mon, 11 Jul 2022 10:22:47 +0200 Subject: [PATCH] Update readme and changelog --- CHANGELOG.md | 8 +++++++- README.md | 31 +++++++++++++++++++------------ src/cli.rs | 2 +- 3 files changed, 27 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6535be9..a59998c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). +## [0.3.5] +### Added +- `--pass-path` option to get the password from [pass](https://www.passwordstore.org/) (PR [#33] by [@Ma27]) + ## [0.3.4] ### Added - Display a warning if two or more courses/folders have the same name ([#31]) @@ -158,6 +162,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ## [0.1.0] - 2020-04-21 (undocumented) +[#33]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/pull/33 [#31]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/issues/31 [#30]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/issues/30 [#28]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/pull/28 @@ -180,7 +185,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). [@Craeckie]: https://github.com/Craeckie [@funnym0nk3y]: https://github.com/funnym0nk3y [@Ma27]: https://github.com/Ma27 -[Unreleased]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.3.4...HEAD +[Unreleased]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.3.5...HEAD +[0.3.5]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.3.5...v0.3.4 [0.3.4]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.3.3...v0.3.4 [0.3.3]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.3.2...v0.3.3 [0.3.2]: https://github.com/FliegendeWurst/KIT-ILIAS-downloader/compare/v0.3.1...v0.3.2 diff --git a/README.md b/README.md index 8606563..487e993 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,7 @@ $ KIT-ILIAS-downloader -o ./ILIAS/WS2021-HM1 --sync-url 'https://ilias.studium.k ### Options ``` -$ KIT-ILIAS-downloader --help -KIT-ILIAS-downloader 0.3.3 +KIT-ILIAS-downloader 0.3.5 USAGE: KIT-ILIAS-downloader [FLAGS] [OPTIONS] --output @@ -58,18 +57,19 @@ FLAGS: -v Verbose logging OPTIONS: - -j, --jobs Parallel download jobs [default: 1] - -o, --output Output directory - -P, --password KIT account password - -p, --proxy Proxy, e.g. socks5h://127.0.0.1:1080 - --rate Requests per minute [default: 8] - --sync-url ILIAS page to download - -U, --username KIT account username + -j, --jobs Parallel download jobs [default: 1] + -o, --output Output directory + --pass-path Path inside `pass(1)` to the password for your KIT account + -P, --password KIT account password + -p, --proxy Proxy, e.g. socks5h://127.0.0.1:1080 + --rate Requests per minute [default: 8] + --sync-url ILIAS page to download + -U, --username KIT account username ``` ### .iliasignore -.gitignore syntax can be used in a `.iliasignore` file: (located in the output folder) +.gitignore syntax can be used in a `.iliasignore` file: (located in the output directory) ```ignore # example 1: only download a single course /*/ @@ -81,18 +81,25 @@ OPTIONS: ### Credentials -You can use the `--user` and `--keyring` options to get/store the password using the system password store. -If you use Linux, you'll have to compile from source to be able to use this option. +You can use the `--user` and `--keyring` options to get/store the password using the system password store: ``` $ KIT-ILIAS-downloader -U uabcd --keyring [...] ``` +If you use [pass](https://www.passwordstore.org/), you can use the `--pass-path` option to specify which password store entry to use: +``` +$ KIT-ILIAS-downloader -U uabcd --pass-path edu/kit/uskyk [...] +``` + You can also save your username and password in a `.iliaslogin` file: (located in the output folder) ``` username password ``` +When running the downloader multiple times in a short period of time, you may want to use the `--keep-session` flag. +If specified, the downloader will save and restore session cookies (`.iliassession` file in the output directory). + ### Renaming course names (0.2.24+) If you'd like to avoid unwieldy course names (e.g. "24030 – Programmierparadigmen"), you can create a `course_names.toml` file in the output directory. It should contain the desired mapping of course names to folder names, e.g.: ``` diff --git a/src/cli.rs b/src/cli.rs index 8152eb3..1918519 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -74,7 +74,7 @@ pub struct Opt { #[structopt(short = "P", long)] pub password: Option, - /// Path inside `pass(1)` to the password for shibboleth. + /// Path inside `pass(1)` to the password for your KIT account #[structopt(long)] pub pass_path: Option,