BBBikeDownloader.get_sub_catalogue

BBBikeDownloader.get_sub_catalogue(subregion_name, update=False, confirmation_required=True, verbose=False, raise_error=False)[source]

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

  • 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

  • raise_error (bool) – Whether to raise the provided exception; if raise_error=False (default), the error will be suppressed.

Returns:

a catalogues for subregion downloads

Return type:

pandas.DataFrame | None

Examples:

>>> from pydriosm.downloader import BBBikeDownloader
>>> bbd = BBBikeDownloader()
>>> subregion_name = 'birmingham'
>>> # A download catalogue for Leeds
>>> bham_catalogue = bbd.get_sub_catalogue(subregion_name, verbose=True)
To retrieve/compile data of a download catalogue for "Birmingham"
? [No]|Yes: yes
Retrieving/compiling the data ... Done.
>>> bham_catalogue.shape
(15, 5)
>>> bham_catalogue.head()
                                   filename  ...                last_update
0                        Birmingham.osm.pbf  ...  2026-02-28 18:54:17+00:00
1                         Birmingham.osm.gz  ...  2026-03-01 04:52:14+00:00
2                    Birmingham.osm.shp.zip  ...  2026-03-01 05:40:06+00:00
3  Birmingham.osm.garmin-ontrail-latin1.zip  ...  2026-03-01 06:15:16+00:00
4   Birmingham.osm.garmin-onroad-latin1.zip  ...  2026-03-01 06:14:56+00:00
[5 rows x 5 columns]
>>> bham_catalogue.columns.tolist()
['filename', 'url', 'data_type', 'size', 'last_update']