read_files

Summary

read_files(files: list[Path]) list[Bundle]

Reads one or more Map Bundles from a single directory. (A list of files)

Parameters:

files (list[Path]) – A list of Path objects representing each file. Should at least include filename if they are in the same directory as your current shell but should include path as well if they are elsewhere.

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_files