GeofabrikDownloader.get_subregion_download_url

GeofabrikDownloader.get_subregion_download_url(subregion_name, osm_file_format, update=False, verbose=False)[source]

Get a download URL of a geographic (sub)region.

Parameters:

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

  • osm_file_format (str) – file format/extension of the OSM data available on the download server

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

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

Returns:

name and URL of the subregion

Return type:

Tuple[str, str | None]

Examples:

>>> from pydriosm.downloader import GeofabrikDownloader

>>> gfd = GeofabrikDownloader()

>>> subrgn_name = 'England'
>>> file_format = ".pbf"
>>> valid_name, dwnld_link = gfd.get_subregion_download_url(subrgn_name, file_format)
>>> valid_name  # The name of the subregion on the free downloader server
'England'
>>> dwnld_link  # The URL of the PBF data file
'https://download.geofabrik.de/europe/great-britain/england-latest.osm.pbf'

>>> subrgn_name = 'britain'
>>> file_format = ".shp"
>>> valid_name, dwnld_link = gfd.get_subregion_download_url(subrgn_name, file_format)
>>> valid_name
'Great Britain'
>>> dwnld_link is None  # The URL of the shapefile for Great Britain is not available
True