GeofabrikDownloader.get_catalogue

GeofabrikDownloader.get_catalogue(update=False, confirmation_required=True, verbose=False, raise_error=False)[source]

Get a catalogue (index) of all available downloads.

Similar to get_download_index().

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

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

Returns:

a catalogue for all subregion downloads

Return type:

pandas.DataFrame | None

Examples:

>>> from pydriosm.downloader import GeofabrikDownloader
>>> gfd = GeofabrikDownloader()
>>> # A download catalogue for all subregions
>>> dwnld_catalog = gfd.get_catalogue()
>>> type(dwnld_catalog)
pandas.DataFrame
>>> dwnld_catalog.shape
(543, 7)
>>> dwnld_catalog.head()
               subregion  ... .osm.bz2
0                 Africa  ...     None
1             Antarctica  ...     None
2                   Asia  ...     None
3  Australia and Oceania  ...     None
4        Central America  ...     None
[5 rows x 7 columns]
>>> dwnld_catalog.columns.to_list()
['subregion',
 'subregion-url',
 '.osm.pbf',
 '.osm.pbf-size',
 '.gpkg.zip',
 '.shp.zip',
 '.osm.bz2']

Note