grimoirelab-perceval
grimoirelab-perceval copied to clipboard
Incorect "usage" argument order for github backend
First time user here. I was finally able to successfully export GitHub data, thanks!
perceval github --help
gives
usage: perceval [-h] [--category CATEGORY] [--tag TAG] [--filter-classified] [--from-date FROM_DATE] [--to-date TO_DATE] [--archive-path ARCHIVE_PATH] [--no-archive] [--fetch-archive]
[--archived-since ARCHIVED_SINCE] [--no-ssl-verify] [-o OUTFILE] [--json-line] [--enterprise-url BASE_URL] [--sleep-for-rate] [--min-rate-to-sleep MIN_RATE_TO_SLEEP] [-t API_TOKEN [API_TOKEN ...]]
[--github-app-id GITHUB_APP_ID] [--github-app-pk-filepath GITHUB_APP_PK_FILEPATH] [--max-items MAX_ITEMS] [--max-retries MAX_RETRIES] [--sleep-time SLEEP_TIME]
owner repository
but it's actually
usage: perceval github owner repository [-h] [--category CATEGORY] [--tag TAG] [--filter-classified] [--from-date FROM_DATE] [--to-date TO_DATE] [--archive-path ARCHIVE_PATH] [--no-archive] [--fetch-archive]
[--archived-since ARCHIVED_SINCE] [--no-ssl-verify] [-o OUTFILE] [--json-line] [--enterprise-url BASE_URL] [--sleep-for-rate] [--min-rate-to-sleep MIN_RATE_TO_SLEEP] [-t API_TOKEN [API_TOKEN ...]]
[--github-app-id GITHUB_APP_ID] [--github-app-pk-filepath GITHUB_APP_PK_FILEPATH] [--max-items MAX_ITEMS] [--max-retries MAX_RETRIES] [--sleep-time SLEEP_TIME]
- It doesn't have the backend in the usage
- It has "owner repository" at the end, but they need to appear before the other arguments (it does list "positional arguments" first in the text that follows)
Maybe this is some weird standard way to output the usage, but I found it confusing and I think this would be better if it were in the correct order and included the backend in the usage.
You are right. This is a bug. Thanks for reporting it. It's the same behaviour with the other backeds too.