validate_bundle

Summary

validate_bundle(bundles: list[Bundle], gdrive_api_key=None, skip_consistency_test=False, skip_board_configuration_test=False, skip_icon_test=False, skip_max_paths_test=False, skip_music_download_test=False, skip_naming_convention_test=False, skip_screenshots_test=False, skip_venture_cards_test=False, skip_warnings=False) → ValidationResultBundle

The entry-point for validating board bundles.

Parameters:

  • bundles (list[Bundle]) – A list of Bundle objects representing your board bundle(s).

  • gdrive_api_key (string, optional) – Optional. Needed in order to run the Music Download test if one of your download mirrors is Google Drive. Not used otherwise.

  • skip_consistency_test (bool, optional) – If set to True, the Consistency Check will be skipped. Defaults to False.

  • skip_board_configuration_test (bool, optional) – If set to True, the Board Configuration Checks will be skipped. Defaults to False.

  • skip_mapicon_test – If set to True, the Map Icon Check will be skipped. Defaults to False.

  • skip_max_paths_test (bool, optional) – If set to True, the Max Paths Check will be skipped. Defaults to False.

  • skip_music_download_test (bool, optional) – If set to True, the Music Download Check will be skipped. Defaults to False.

  • skip_naming_convention_test (bool, optional) – If set to True, the Naming Convention Check will be skipped. Defaults to False.

  • skip_screenshots_test (bool, optional) – If set to True, the FRB/Screenshot Check will be skipped. Defaults to False.

  • skip_venture_cards_test (bool, optional) – If set to True, the Venture Card Checks will be skipped. Defaults to False.

  • skip_warnings (bool, optional) – If set to True, the Venture Card Checks that return Warning messages will be skipped. Defaults to False.

Returns:

A bundle containing the overall results, as well as a list containing objects that represent each of the individual results.

Return type:

ValidationResultBundle

Importing

from cs_board_tools.validation.main import validate_bundle