arctool.utils

Module containing arctool API.

arctool.utils.new_archive_dataset(staging_path, descriptive_metadata)[source]

Create new archive in the staging path.

This creates an initial skeleton directory structure that includes a top level README.yml file.

Parameters:
  • staging_path – path to archiving staging area
  • descriptive_metadata – dictionary with information which will populate README.yml
Returns:

(dataset, path to newly created data set archive in the staging area)

arctool.utils.readme_yml_is_valid(yml_string)[source]

Return True if string representing README.yml content is valid.

Parameters:yml_string – string representing content of readme file
Returns:bool