BBBikeDownloader.get_subregion_index

classmethod BBBikeDownloader.get_subregion_index(update=False, confirmation_required=True, verbose=False)[source]

Get a catalogue for geographic (sub)regions.

Parameters:

update (bool) – whether to (check on and) update the prepacked data, defaults to False
confirmation_required (bool) – whether asking for confirmation to proceed, defaults to True
verbose (bool | int) – whether to print relevant information in console, defaults to False

Returns:

catalogue for subregions of BBBike data

Return type:

pandas.DataFrame | None

Examples:

>>> from pydriosm.downloader import BBBikeDownloader

>>> bbd = BBBikeDownloader()

>>> # A BBBike catalogue of geographic (sub)regions
>>> subrgn_idx = bbd.get_subregion_index()

>>> type(subrgn_idx)
pandas.core.frame.DataFrame
>>> subrgn_idx.columns.to_list()
['name', 'last_modified', 'url']