pfhub icon indicating copy to clipboard operation
pfhub copied to clipboard

PFHub CLI tool

Open wd15 opened this issue 1 year ago • 2 comments

A CLI to download, submit and convert PFHub results

Some of these commits are in #1508

Todo:

  • [x] implementing convert-to-zenodo
    • [x] return unpacked files
  • [x] ensure that the schema.yaml file is installed
  • [x] clean up for push to github
  • [x] test without pfhub working copy available in github actions
  • [x] implement pfhub.yaml check
  • [x] download from a pfhub record name
  • [ ] allow download_zenodo to use local files and keep the URLs
  • [ ] implement convert-to-meta
  • [ ] check two way conversion
  • [ ] API docs?
  • [ ] ensure validate checks the specific data for each benchmark

Ideas:

  • pfhub upload {zenodo-record} --sandbox ???
    • upload to zenodo
    • sandbox=true to submit to Zenodo sandbox
    • require a ~.pfhubrc file locally to set parameters for zenodo and pfhub submission
    • use zenodo-client for submission
  • pfhub submit --path=./ --config_path=~/pfhubrc --sandbox=true
    • open pfhub PR
  • pfhub convert
    • convert a meta.yaml to pfhub.yaml
  • pfhub check
    • lint a submission
  • pfhub generate_notebook?
    • generates a notebook of the result
  • pfhub generate_yaml?
    • take previous yaml and ask questions maybe
    • question and answer
    • generate from ~/.pfhub.ini
  • Workflow order:
    • download existing record
    • convert or generate_yaml
    • check or generate_notebook
    • upload_to_zenodo
    • submit_to_pfhub
  • Test in environment without pfhub working copy available

Done:

  • submit to pypi testing
  • implemented pfhub CLI
  • tested python-pfhub with pip install
  • implement versioneer
  • add download command for both meta.yaml and Zenodo links

wd15 avatar Aug 07 '23 20:08 wd15