stormwater_monitoring_datasheet_extraction.api package¶
Submodules¶
stormwater_monitoring_datasheet_extraction.api.internal module¶
Internal functions for the stormwater monitoring datasheet extraction API.
- stormwater_monitoring_datasheet_extraction.api.internal.run_etl(input_dir, output_dir)¶
Extracts, verifies, cleans, and loads datasheet images.
Extracts data from the images in the input directory, verifies the extraction with the user, cleans and validates the data, and loads it into the output directory.
- Parameters:
input_dir (
Path) – Path to the input directory containing datasheet images.output_dir (
Path) – Path to the output directory where processed data will be saved. If empty path, defaults to a dated directory in the current working directory.
- Return type:
Path- Returns:
Path to the saved cleaned data file.
stormwater_monitoring_datasheet_extraction.api.public module¶
Public functions for the stormwater monitoring datasheet extraction API.
- stormwater_monitoring_datasheet_extraction.api.public.run_etl(input_dir, output_dir)¶
Extracts, verifies, cleans, and loads datasheet images.
Extracts data from the images in the input directory, verifies the extraction with the user, cleans and validates the data, and loads it into the output directory.
- Parameters:
input_dir (
Path) – Path to the input directory containing datasheet images.output_dir (
Path) – Path to the output directory where processed data will be saved. If empty path, defaults to a dated directory in the current working directory.
- Return type:
Path- Returns:
Path to the saved cleaned data file.
Module contents¶
Top-level public and internal interfaces.