get_site_map
- pyrcs.parser.get_site_map(update=False, confirmation_required=True, verbose=False)[source]
Fetch the site map from the package data.
- Parameters:
update (bool) – whether to do an update check (for the package data), defaults to
False
confirmation_required (bool) – whether to confirm before proceeding, defaults to
True
verbose (bool | int) – whether to print relevant information in console, defaults to
False
- Returns:
dictionary of site map data
- Return type:
collections.OrderedDict | None
Examples:
>>> from pyrcs.parser import get_site_map >>> site_map_dat = get_site_map() >>> type(site_map_dat) collections.OrderedDict >>> list(site_map_dat.keys()) ['Home', 'Line data', 'Other assets', '"Legal/financial" lists', 'Miscellaneous'] >>> site_map_dat['Home'] {'index.shtml': 'http://www.railwaycodes.org.uk/index.shtml'}