prereise.cli package

Subpackages

• prereise.cli.data_sources package
  • Subpackages
    • prereise.cli.data_sources.tests package
      • Submodules
      • prereise.cli.data_sources.tests.conftest module
      • prereise.cli.data_sources.tests.test_data_source module
      • prereise.cli.data_sources.tests.test_demand_data module
      • prereise.cli.data_sources.tests.test_hydro_data module
      • prereise.cli.data_sources.tests.test_solar_data module
      • prereise.cli.data_sources.tests.test_wind_data module
      • Module contents
  • Submodules
  • prereise.cli.data_sources.data_source module
    • DataSource
      • DataSource.command_help
      • DataSource.command_name
      • DataSource.extract()
      • DataSource.extract_arguments
    • NotSupportedDataSource
      • NotSupportedDataSource.command_help
      • NotSupportedDataSource.extract()
      • NotSupportedDataSource.extract_arguments
  • prereise.cli.data_sources.demand_data module
    • DemandData
      • DemandData.command_name
  • prereise.cli.data_sources.exceptions module
    • CommandNotSupportedError
  • prereise.cli.data_sources.hydro_data module
    • HydroData
      • HydroData.command_name
  • prereise.cli.data_sources.solar_data module
    • SolarDataGriddedAtmospheric
      • SolarDataGriddedAtmospheric.command_help
      • SolarDataGriddedAtmospheric.command_name
      • SolarDataGriddedAtmospheric.extract()
      • SolarDataGriddedAtmospheric.extract_arguments
    • SolarDataNationalSolarRadiationDatabase
      • SolarDataNationalSolarRadiationDatabase.command_help
      • SolarDataNationalSolarRadiationDatabase.command_name
      • SolarDataNationalSolarRadiationDatabase.extract()
      • SolarDataNationalSolarRadiationDatabase.extract_arguments
  • prereise.cli.data_sources.wind_data module
    • WindDataRapidRefresh
      • WindDataRapidRefresh.command_help
      • WindDataRapidRefresh.command_name
      • WindDataRapidRefresh.extract()
      • WindDataRapidRefresh.extract_arguments
  • Module contents
    • get_data_sources_list()
• prereise.cli.download package
  • Subpackages
    • prereise.cli.download.tests package
      • Submodules
      • prereise.cli.download.tests.test_download_manager module
      • Module contents
  • Submodules
  • prereise.cli.download.download_manager module
    • generate_parser()
    • main()
  • Module contents
• prereise.cli.tests package
  • Submodules
  • prereise.cli.tests.test_helpers module
    • data_source()
    • test_add_data_source_to_download_parser()
    • test_validate_date()
    • test_validate_date_bad_date()
    • test_validate_file_path()
    • test_validate_file_path_bad_path()
    • test_validate_file_path_is_direcotry()
    • test_validate_year()
    • test_validate_year_bad_year()
  • Module contents

Submodules

prereise.cli.constants module

prereise.cli.helpers module

prereise.cli.helpers.add_data_source_to_download_parser(data_source, subparsers)

Helper function that adds an additional source of data that the user can interact with and download via the command line tool

Parameters:

• data_source (prereise.cli.data_sources.data_source.DataSource) – an instance of a class that implements the abstract class DataSource

• subparsers (argparse.ArgumentParser) – subparser object that implements command line interface functionality

prereise.cli.helpers.validate_date(date_string)

Helper function to validate date strings

Parameters:

date_string (str) – date in string format to be validated

Returns:

(str) – validated date string

prereise.cli.helpers.validate_file_path(file_path)

Helper function to validate file paths

Parameters:

file_path (str) – path include filename for where to save the file

Raises:

ValueError – if the provided file path is not accessible

Returns:

(str) – validated file path

prereise.cli.helpers.validate_year(year_string)

Helper function to validate year strings

Parameters:

year_string (str) – year in string format to be validated

Returns:

(str) – validated year string

Module contents