BBBikeDownloader.get_subregion_download_catalogue

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

Get a download catalogue of OSM data available for a geographic region.

Parameters

  • subregion_name (str) – name of a geographic 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

Example:

>>> from pydriosm.downloader import BBBikeDownloader

>>> bbbike_downloader = BBBikeDownloader()

>>> region_name = 'leeds'

>>> # A download catalogue for Leeds
>>> leeds_dwnld_cat = bbbike_downloader.get_subregion_download_catalogue(
...     subregion_name=region_name, verbose=True)
To collect the download catalogue for "Leeds"
? [No]|Yes: yes
Collecting the data ... Done.

>>> leeds_dwnld_cat.head()
                             Filename  ...          LastUpdate
0                       Leeds.osm.pbf  ... 2020-09-25 10:04:25
1                        Leeds.osm.gz  ... 2020-09-25 15:11:49
2                   Leeds.osm.shp.zip  ... 2020-09-25 15:33:10
3  Leeds.osm.garmin-onroad-latin1.zip  ... 2020-09-25 17:49:15
4         Leeds.osm.garmin-onroad.zip  ... 2020-09-25 17:49:04
[5 rows x 5 columns]

>>> leeds_dwnld_cat.columns.tolist()
['Filename', 'URL', 'DataType', 'Size', 'LastUpdate']