pyrcs.updater.collect_site_map¶

pyrcs.updater.collect_site_map(confirmation_required=True)[source]¶

Collect data of the site map from source web page.

Parameters: confirmation_required (bool) – whether to prompt a message for confirmation to proceed, defaults to True
Returns: dictionary of site map data
Return type: dict

Examples:

>>> from pyrcs.updater import collect_site_map

>>> site_map_dat = collect_site_map()
To collect the site map? [No]|Yes: yes

>>> type(site_map_dat)
<class 'dict'>
>>> print(list(site_map_dat.keys()))
['Home', 'Line data', 'Other assets', '"Legal/financial" lists', 'Miscellaneous']