dicogis.cli.cmd_inventory module

dicogis.cli.cmd_inventory.inventory(input_folder=None, formats='dgn,esri_shapefile,file_geodatabase_esri,file_geodatabase_geopackage,file_geodatabase_spatialite,geojson,gml,gxt,kml,mapinfo_tab,ecw,geotiff,jpeg', pg_services=None, output_path=None, output_format='excel', opt_notify_sound=True, opt_open_output=True, opt_prettify_size=False, opt_quick_fail=False, opt_raw_path=False, opt_parallel_scan=False, listing_max_workers=None, language=None, verbose=False)

List, extract metadata from geospatial datasets (files or database) and store it as files.

Make an inventory of geodata files starting from a folder and/or databases using connection listed in pg_service.conf and store everything in an output file.

Parameters:

  • input_folder (Path | None) – starting folder for files. Defaults to None.

  • formats (str) – List of files extensions to include into listing. Defaults to every supported formats.

  • pg_services (list[str] | None) – name(s) of PostgreSQL services to use. Repeatable. If None, database listing is ignored. Defaults to None.

  • language (AvailableLocales | None) – language code to use. If not set, the current default locale is used. Defaults to None.

  • verbose (bool) – enable verbose mode. Defaults to False.

dicogis.cli.cmd_inventory.serialize_pg_service_layers(sgbd_reader, output_serializer)

Serialize the metadata of every layer exposed by a connected PostGIS service.

Parameters:
Return type:

int

Returns:

number of layers read from this service