Skip to content

download-and-extract

Automatically generated README for this automation recipe: download-and-extract

Category: DevOps automation

License: Apache 2.0

  • Notes from the authors, contributors and users: README-extra

  • CM meta description for this script: _cm.json

  • Output cached? False

Reuse this script in your project

Install MLCommons CM automation meta-framework

Pull CM repository with this automation recipe (CM script)

cm pull repo mlcommons@cm4mlops

cmr "download-and-extract file" --help

Run this script

Run this script via CLI
cm run script --tags=download-and-extract,file[,variations] [--input_flags]
Run this script via CLI (alternative)
cmr "download-and-extract file [variations]" [--input_flags]
Run this script from Python
import cmind

r = cmind.access({'action':'run'
              'automation':'script',
              'tags':'download-and-extract,file'
              'out':'con',
              ...
              (other input keys for this script)
              ...
             })

if r['return']>0:
    print (r['error'])
Run this script via Docker (beta)
cm docker script "download-and-extract file[variations]" [--input_flags]

Variations

  • No group (any combination of variations can be selected)

    Click here to expand this section.

    • _extract
      • ENV variables:
        • CM_DAE_EXTRACT_DOWNLOADED: yes
    • _keep
      • ENV variables:
        • CM_EXTRACT_REMOVE_EXTRACTED: no
    • _no-remove-extracted
      • ENV variables:
        • CM_EXTRACT_REMOVE_EXTRACTED: no
    • _url.#
      • ENV variables:
        • CM_DAE_URL: #

  • Group "download-tool"

    Click here to expand this section.

    • _cmutil (default)
    • _curl
    • _gdown
    • _rclone
    • _torrent
      • ENV variables:
        • CM_DAE_DOWNLOAD_USING_TORRENT: yes
        • CM_TORRENT_DOWNLOADED_FILE_NAME: <<<CM_DAE_FILENAME>>>
        • CM_TORRENT_DOWNLOADED_PATH_ENV_KEY: CM_DAE_FILEPATH
        • CM_TORRENT_WAIT_UNTIL_COMPLETED: yes
    • _wget
Default variations

_cmutil

Script flags mapped to environment

  • --download_path=value → CM_DOWNLOAD_PATH=value
  • --extra_folder=value → CM_EXTRACT_TO_FOLDER=value
  • --extract_path=value → CM_EXTRACT_PATH=value
  • --from=value → CM_DOWNLOAD_LOCAL_FILE_PATH=value
  • --local_path=value → CM_DOWNLOAD_LOCAL_FILE_PATH=value
  • --store=value → CM_DOWNLOAD_PATH=value
  • --to=value → CM_EXTRACT_PATH=value
  • --url=value → CM_DAE_URL=value
  • --verify=value → CM_VERIFY_SSL=value

Script output

cmr "download-and-extract file [variations]" [--input_flags] -j