UX: command line help could be more helpful

[FObersteiner]

with the current version, I get

❯ cloudnet-submit -h
usage: cloudnet-submit [-h] [--version] [--generate-config] [-c CONFIG] [-n] [-d [DATE ...]] [-l LAST_NDAYS] [--from-date FROM_DATE] [--to-date TO_DATE] [--host HOST] [--port PORT]

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --generate-config
  -c, --config CONFIG
  -n, --dry-run
  -d, --date [DATE ...]
  -l, --last-ndays LAST_NDAYS
  --from-date FROM_DATE
  --to-date TO_DATE
  --host HOST
  --port PORT

There are no descriptions nor defaults shown - which I found confusing, for instance -l has a derived value of 3 days which I only realized after what I wanted to do did not work.

I can make a PR if you'd like.

[nikoleskinen]

Agreed. We will fix that. Thanks for the feedback :)

[FObersteiner]

Here's an updated version, see #3:

❯ cloudnet-submit -h
usage: cloudnet-submit [-h] [--version] [--generate-config] [-c CONFIG] [-n] [-d [DATE ...]] [-l N] [--from-date DATE] [--to-date DATE] [--host HOST] [--port PORT]

Submit Cloudnet instrument and model data to the Cloudnet data portal.

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --generate-config     generate an example configuration file and exit
  -c, --config CONFIG   path to configuration file (default: cloudnet-config.toml)
  -n, --dry-run         simulate submission without uploading data
  -d, --date [DATE ...]
                        specific date(s) to submit in ISO format (YYYY-MM-DD). can be specified multiple times.
  -l, --last-ndays N    submit data from the last N days (positive integer). default: last 3 days when no date options specified.
  --from-date DATE      start date for date range (ISO format: YYYY-MM-DD). defaults to today if --to-date is given without this.
  --to-date DATE        end date for date range (ISO format: YYYY-MM-DD). defaults to today if omitted.
  --host HOST           cloudnet data portal base URL (default: https://cloudnet.fmi.fi)
  --port PORT           override port for the data portal URL (appended to --host). default: standard HTTPS port (443).

Examples:
  cloudnet-submit --generate-config        # Generate example config file
  cloudnet-submit -n                       # Dry run, no actual submission
  cloudnet-submit                          # Submit last 3 days
  cloudnet-submit -d 2024-01-15            # Submit specific date
  cloudnet-submit -l 7                     # Submit last 7 days
  cloudnet-submit --from-date 2024-01-01 --to-date 2024-01-31 # Submit date range

[siiptuo]

Your changes are in the newly released v0.1.3. Thanks for the contribution!