diff --git a/.github/sync-repo-settings.yaml b/.github/sync-repo-settings.yaml index 048267a..38129f5 100644 --- a/.github/sync-repo-settings.yaml +++ b/.github/sync-repo-settings.yaml @@ -1,2 +1,8 @@ # Automatically delete head branches after merging PRs. Defaults to `true`. deleteBranchOnMerge: true + +# Rules for branch protection (add multiple entries to configure multiple branches) +branchProtectionRules: + # Identifies the protection rule pattern. Name of the branch to be protected. + # Defaults to `master` + - pattern: main diff --git a/.gitignore b/.gitignore index 219a425..8dd734d 100644 --- a/.gitignore +++ b/.gitignore @@ -174,3 +174,4 @@ *.gif dist +outputs diff --git a/README.md b/README.md index ea8bd84..b5ab7ac 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ ## Features +- fast concurrent download - pretty TUI powered by [rich](https://github.com/Textualize/rich) - auto set `mtime` of downloaded files according to timestamp of remote file - auto skip download when local file is newer @@ -32,6 +33,15 @@ ## Usage +### Pre-built Binary + 1. Download pre-built binary from [releases](https://github.com/liblaf/thu-learn-downloader/releases). 2. Prepare a `config.yaml` like [config.yaml](https://github.com/liblaf/thu-learn-downloader/blob/main/config.yaml). 3. Run `thu-learn-downloader password="***"` and wait for the sync to finish. + +### pip + +```shell +pip install thu-learn-downloader +python -m thu_learn_downloader username="***" password="***" +``` diff --git a/thu_learn_downloader/__main__.py b/thu_learn_downloader/__main__.py index 9ef3ca4..baa23e2 100644 --- a/thu_learn_downloader/__main__.py +++ b/thu_learn_downloader/__main__.py @@ -65,4 +65,4 @@ if __name__ == "__main__": - pass + main()