Skip to content

yasp-toolkit dataset

Manage datasets attached to embedded compile tasks. A dataset definition is stored locally; its S3 access/secret pair lives in the OS keyring. Use embedded compile --dataset <name> to attach one to a task.

Usage:

$ yasp-toolkit dataset [OPTIONS] COMMAND [ARGS]...

Options: * --help: Show this message and exit.

Commands:

  • add: Register a dataset and store its S3...
  • copy: Register a new dataset cloned from...
  • list: List all configured datasets, with live...
  • show: Print a dataset's spec (secrets are not...
  • remove: Remove a dataset definition and its stored...
  • sign: Build (or reuse a cached) gzipped manifest...
  • cache: Manage the local manifest cache.

yasp-toolkit dataset add

Register a dataset and store its S3 credentials in the OS keyring.

Prompts for credentials and tests them against the endpoint before storing — re-prompts on failure. An empty value at either prompt aborts without writing anything.

Usage:

$ yasp-toolkit dataset add [OPTIONS] {name}
Argument Default Description
name required Dataset name (e.g. traffic-image-samples).
Option Default Description
--endpoint <str> required S3-compatible endpoint URL.
--bucket <str> required Bucket name.
--prefix <str> required Object key prefix (use '' for the whole bucket).
--region <str> required Bucket region.
--mechanism <str> presigned Delegation mechanism (only presigned today).

yasp-toolkit dataset copy

Register a new dataset cloned from source, replacing only its prefix.

Endpoint, region, bucket, and mechanism are carried over unchanged, and the source's stored credentials are copied to the new dataset.

Usage:

$ yasp-toolkit dataset copy [OPTIONS] {source} {dest}
Argument Default Description
source required Name of the existing dataset to copy from.
dest required Name for the new dataset.
Option Default Description
--prefix <str> required Object key prefix for the new dataset (use '' for the whole bucket).

yasp-toolkit dataset list

List all configured datasets, with live credential status.

Usage:

$ yasp-toolkit dataset list [OPTIONS]

Options: * --help: Show this message and exit.

yasp-toolkit dataset show

Print a dataset's spec (secrets are not printed, only their presence).

Usage:

$ yasp-toolkit dataset show [OPTIONS] {name}
Argument Default Description
name required Dataset name.

Options: * --help: Show this message and exit.

yasp-toolkit dataset remove

Remove a dataset definition and its stored credentials.

Usage:

$ yasp-toolkit dataset remove [OPTIONS] {name}
Argument Default Description
name required Dataset name to remove.

Options: * --help: Show this message and exit.

yasp-toolkit dataset sign

Build (or reuse a cached) gzipped manifest for the named dataset.

Usage:

$ yasp-toolkit dataset sign [OPTIONS] {name}
Argument Default Description
name required Dataset name.
Option Default Description
--ttl <str> 12h URL validity, e.g. 12h, 30m, 1d2h.
--refresh Force a rebuild even if a cached manifest is still valid.
-o, --output <path> Copy the signed manifest to this path (else just cache it).

yasp-toolkit dataset cache

Manage the local manifest cache.

Usage:

$ yasp-toolkit dataset cache [OPTIONS] COMMAND [ARGS]...

Options: * --help: Show this message and exit.

Commands:

  • clear: Drop cached manifests.

yasp-toolkit dataset cache clear

Drop cached manifests.

Usage:

$ yasp-toolkit dataset cache clear [OPTIONS] [name]
Argument Default Description
name Only clear this dataset's cached manifests (else all).

Options: * --help: Show this message and exit.