GeofabrikDownloader.make_sub_download_dir

GeofabrikDownloader.make_sub_download_dir(subregion_name, osm_file_format, download_dir=None, mkdir=False)[source]

Make a default directory for downloading data of a geographic region’s subregions.

This is particularly useful when data of a geographic region and requested file format is unavailable.

Parameters

  • subregion_name (str) – name of a geographic region (case-insensitive) available on Geofabrik’s free download server

  • osm_file_format (str) – OSM file format; valid values include ".osm.pbf", ".shp.zip" and ".osm.bz2"

  • download_dir (str or None) – directory for saving the downloaded file(s); if None (default), the default directory

  • mkdir (bool) – whether to create a directory, defaults to False

Returns

default download directory if the requested data file is not available

Return type

str

Example:

>>> import os
>>> from pydriosm.downloader import GeofabrikDownloader

>>> geofabrik_downloader = GeofabrikDownloader()

>>> sr_name = 'london'
>>> file_format = ".pbf"

>>> dwnld_dir = geofabrik_downloader.make_sub_download_dir(
...     sr_name, file_format)

>>> print(os.path.relpath(dwnld_dir))
# dat_GeoFabrik\Europe\Great Britain\England\greater-london-latest-osm-pbf

>>> sr_name = 'britain'
>>> file_format = ".shp"

>>> dwnld_dir = geofabrik_downloader.make_sub_download_dir(
...     sr_name, file_format, download_dir="tests")

>>> print(os.path.relpath(dwnld_dir))
tests\great-britain-shp-zip