read_frb

Summary

read_frb(file_path: Path) BoardFile

Reads an .frb file in and returns a BoardFile object representing it.

Parameters:

file_path (str) – A filename for a Fortune Avenue-compatible .frb board file.

Returns:

Returns a BoardFile object, containing all of the values that live inside the .frb file we provided.

Return type:

BoardFile

Importing

from cs_board_tools.schema.frb import read_frb