From 3e9a4fa0d885ae0e348df62d40f8c36c16b4076a Mon Sep 17 00:00:00 2001 From: BrOleg5 Date: Fri, 5 Jan 2024 20:35:37 +0800 Subject: [PATCH] Update CLI help output in README. Rename destination of latest-releases argument. --- README.rst | 5 +++-- github_backup/github_backup.py | 6 +++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 22c39d7..82dc479 100644 --- a/README.rst +++ b/README.rst @@ -49,7 +49,8 @@ CLI Help output:: [-P] [-F] [--prefer-ssh] [-v] [--keychain-name OSX_KEYCHAIN_ITEM_NAME] [--keychain-account OSX_KEYCHAIN_ITEM_ACCOUNT] - [--releases] [--assets] [--latest-releases INCLUDE_LATEST_RELEASES] + [--releases] [--latest-releases NUMBER_OF_LATEST_RELEASES] + [--skip-prerelease] [--assets] [--exclude [REPOSITORY [REPOSITORY ...]] [--throttle-limit THROTTLE_LIMIT] [--throttle-pause THROTTLE_PAUSE] USER @@ -125,7 +126,7 @@ CLI Help output:: keychain that holds the personal access or OAuth token --releases include release information, not including assets or binaries - --latest-releases INCLUDE_LATEST_RELEASES + --latest-releases NUMBER_OF_LATEST_RELEASES include certain number of the latest releases; only applies if including releases --skip-prerelease skip prerelease and draft versions; only applies if including releases diff --git a/github_backup/github_backup.py b/github_backup/github_backup.py index 2761336..13fef00 100644 --- a/github_backup/github_backup.py +++ b/github_backup/github_backup.py @@ -381,7 +381,7 @@ def parse_args(args=None): "--latest-releases", type=int, default=0, - dest="include_latest_releases", + dest="number_of_latest_releases", help="include certain number of the latest releases; only applies if including releases", ) parser.add_argument( @@ -1223,10 +1223,10 @@ def backup_releases(args, repo_cwd, repository, repos_template, include_assets=F if args.skip_prerelease: releases = [r for r in releases if r["prerelease"] == False and r["draft"] == False] - if args.include_latest_releases and args.include_latest_releases < len(releases): + if args.number_of_latest_releases and args.number_of_latest_releases < len(releases): releases.sort(key=lambda item: datetime.strptime(item["created_at"], "%Y-%m-%dT%H:%M:%SZ"), \ reverse=True) - releases = releases[:args.include_latest_releases] + releases = releases[:args.number_of_latest_releases] logger.info("Saving the latest {0} releases to disk".format(len(releases))) else: logger.info("Saving {0} releases to disk".format(len(releases)))