BBBikeDownloader.get_catalogue

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

Get a dict-type index of available formats, data types and a download catalogue.

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:

a list of available formats, a list of available data types and a dictionary of download catalogue

Return type:

dict | None

Examples:

>>> from pydriosm.downloader import BBBikeDownloader

>>> bbd = BBBikeDownloader()

>>> # Index for downloading OSM data available on the BBBike free download server
>>> bbbike_catalogue = bbd.get_catalogue()

>>> list(bbbike_catalogue.keys())
['FileFormat', 'DataType', 'Catalogue']

>>> catalogue = bbbike_catalogue['Catalogue']
>>> type(catalogue)
dict

>>> bham_catalogue = catalogue['Birmingham']
>>> type(bham_catalogue)
pandas.core.frame.DataFrame