get_site_map¶

pyrcs.utils.get_site_map(update=False, confirmation_required=True, verbose=False)[source]¶

Fetch the site map from the package data.

Parameters

update (bool) – whether to check on update and proceed to update the package data, defaults to False
confirmation_required (bool) – whether to prompt a message for confirmation to proceed, defaults to True
verbose (bool or int) – whether to print relevant information in console as the function runs, defaults to False

Returns

dictionary of site map data

Return type

dict or None

Examples:

>>> from pyrcs.utils import get_site_map

>>> site_map_dat = get_site_map()

>>> type(site_map_dat)
<class 'dict'>
>>> print(list(site_map_dat.keys()))
['Home', 'Line data', 'Other assets', '"Legal/financial" lists', 'Miscellaneous']
>>> print(site_map_dat['Home'])
http://www.railwaycodes.org.uk/index.shtml

>>> site_map_dat = get_site_map(update=True, verbose=2)