Scripts and GitHub Actions#
Scripts for executing specific tasks are available in the motbxtools.utils module. They can be run locally, or as automated GitHub Actions.
Script utils.summarise_resources#
Summarise MOTBX resources
This script creates a summary CSV file of MOTBX resources (YAML files).
usage: summarise_resources [-h] version
Positional Arguments#
- version
- The version of the MOTBX resources summary.
DEFAULT: retrieve latest version from ‘resources/MOTBX_version.yaml’. ALTERNATIVE: specify a new version; this will update the latest version specified in ‘resources/MOTBX_version.yaml’.
Default: “latest”
This script can be executed as GitHub Action create_summary.
The following scripts can be executed as GitHub Action validate_resources, which is automatically triggered on pull requests when files in the curated resources directory are changed.
Script utils.populate_resource_keywords#
Add resourceKeywords to MOTBX resources
This script adds resourceKeywords to MOTBX resources (YAML files) based on existing resourceTags.
usage: populate_resource_keywords [-h] file_path
Positional Arguments#
- file_path
File path to MOTBX resource YAML file.
Script utils.validate_resource#
Validate MOTBX resources
This script validates MOTBX resources (YAML files).
usage: validate_resource [-h] file_path
Positional Arguments#
- file_path
File path to MOTBX resource YAML file.