read_zip

Summary

read_zip(file_path: Path, temp_dir_path: str = './temp') → list[Bundle]

Reads one or more Map Bundles from a .zip file.

Parameters:

file_path (Path) – A Path object representing the .zip file. Should at least include filename, but should include path as well if the .zip file is in a different directory than your current shell. ProTip: This .zip file can contain multiple bundles; this is why the function returns list[Bundle].

Returns:

Returns a list of Bundles, representing however many bundles you passed the files in for. If only one, you will get a list of Bundles of length 1.

Return type:

list[Bundle]

Importing

from cs_board_tools.io.bundle import read_zip