BBBikeDownloader.get_subregion_catalogue

BBBikeDownloader.get_subregion_catalogue(subregion_name, confirmation_required=True, verbose=False)

Get a download catalogue of OSM data available for a given geographic (sub)region.

Parameters

  • subregion_name (str) – name of a (sub)region available on BBBike free download server

  • confirmation_required (bool) – whether asking for confirmation to proceed, defaults to True

  • verbose (bool or int) – whether to print relevant information in console, defaults to False

Returns

a catalogues for subregion downloads

Return type

pandas.DataFrame or None

Examples:

>>> from pydriosm.downloader import BBBikeDownloader

>>> bbd = BBBikeDownloader()

>>> subrgn_name = 'birmingham'

>>> # A download catalogue for Leeds
>>> bham_dwnld_cat = bbd.get_subregion_catalogue(subrgn_name, verbose=True)
To compile data of a download catalogue for "Birmingham"
? [No]|Yes: yes
Compiling the data ... Done.
>>> type(bham_dwnld_cat)
pandas.core.frame.DataFrame
>>> bham_dwnld_cat.columns.tolist()
['filename', 'url', 'data_type', 'size', 'last_update']