BBBikeDownloader.get_subregion_catalogue

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

Get a catalogue for geographic regions.

Parameters

  • update (bool) – whether to (check on and) update the package data, defaults to False

  • 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

catalogue for subregions of BBBike data

Return type

pandas.DataFrame or None

Example:

>>> from pydriosm.downloader import BBBikeDownloader

>>> bbbike_downloader = BBBikeDownloader()

>>> # A BBBike catalogue of geographic regions
>>> subregion_catalog = bbbike_downloader.get_subregion_catalogue()

>>> type(subregion_catalog)
pandas.core.frame.DataFrame

>>> subregion_catalog.head()
          Name  ...                                                URL
1       Aachen  ...     https://download.bbbike.org/osm/bbbike/Aachen/
2       Aarhus  ...     https://download.bbbike.org/osm/bbbike/Aarhus/
3     Adelaide  ...   https://download.bbbike.org/osm/bbbike/Adelaide/
4  Albuquerque  ...  https://download.bbbike.org/osm/bbbike/Albuque...
5   Alexandria  ...  https://download.bbbike.org/osm/bbbike/Alexand...
[5 rows x 3 columns]

>>> subregion_catalog.columns.to_list()
['Name', 'Last Modified', 'URL']