zooniverse / panoptes-cli

A command-line interface for Panoptes
Apache License 2.0
18 stars 5 forks source link

Add YAML-based resume instructions to README #172

Closed lcjohnso closed 3 years ago

lcjohnso commented 4 years ago

A valuable new feature in v1.1 was to enable users to resume uploads using a YAML file. Relevant description from blog post:

If the upload fails for any reason – whether that’s an issue with our systems, a problem with your internet connection, a bug in the CLI itself, or if you just decide to stop the upload by pressing ctl-c – the CLI will detect that there was a problem and will ask you if you want to be able to resume the upload later. If you say yes, it will then save a new manifest in YAML format containing the remaining upload queue along with all of the upload’s command line options. Then to resume, you just start a new upload with the YAML manifest instead of the original CSV.

It would be worthwhile to add instructions or example to README to document this new feature.

lcjohnso commented 3 years ago

Closed by #174