geoips.commandline package#

Submodules#

geoips.commandline.args module#

Command line script for kicking off geoips based procflows.

geoips.commandline.args.add_args(parser, arglist=None)[source]#

List of available standard arguments for calling data processing command line.

Parameters:

  • parser (ArgumentParser) – argparse ArgumentParser to add appropriate arguments

  • arglist (list, optional) – list of requested arguments to add to the ArgumentParser, default None. if None, include all arguments

Return type:

No return values (parser modified in place)

geoips.commandline.args.check_command_line_args(arglist, argdict)[source]#

Check formatting of command line arguments.

Parameters:

  • arglist (list of str) – List of desired command line arguments to check within argdict for appropriate formatting

  • argdict (dict) – Dictionary of command line arguments

Returns:

Return True if all arguments are of appropriate formatting.

Return type:

bool

Raises:

TypeError – Incorrect command line formatting

geoips.commandline.args.get_command_line_args(arglist=None, description=None, add_args_func=None, check_args_func=None)[source]#

Parse command line arguments specified by the requested list of arguments.

Parameters:

  • arglist (list, optional) – list of requested arguments to add to the ArgumentParser, default None. if None, include all arguments

  • description (str, optional) – String description of arguments, default None

  • add_args_func (function, optional) – Alternative “add_args” function, default None If None, use internal “add_args”

  • check_args_func (function, optional) – Alternative “check_args” function, default None If None, use internal “check_args”

Returns:

Dictionary of command line arguments

Return type:

dict

geoips.commandline.list_available_modules module#

Simple script to list available modules for each interface.

This includes both dev and stable interfaces. Note this will be deprecated with v2.0, replaced with a new class-based interface implementation.

geoips.commandline.list_available_modules.main()[source]#

Script to list all modules available in the current geoips instantiation.

geoips.commandline.log_setup module#

Geoips module for setting up logging handlers with a specified verbosity.

geoips.commandline.log_setup.setup_logging(verbose=True)[source]#

Set up logging handler.

If you do this the first time with no argument, it sets up the logging for all submodules. Subsequently, in submodules, you can just do LOG = logging.getLogger(__name__)

geoips.commandline.run_procflow module#

Command line script for kicking off geoips based procflows.

MUST call with –procflow.

geoips.commandline.run_procflow.main(get_command_line_args_func=None)[source]#

Script to kick off processing based on command line args.

Parameters:

get_command_line_args_func (function, optional) – Function to use in place of “get_command_line_args”, default None If None, use geoips.commandline.args.get_command_line_args

geoips.commandline.test_interfaces module#

Simple test script to run “test_<interface>_interface” for each interface.

This includes both dev and stable interfaces. Note this will be deprecated with v2.0 - replaced with a new class-based interface implementation.

geoips.commandline.test_interfaces.main()[source]#

Script to test all dev and stable interfaces.

geoips.commandline.update_tc_tracks_database module#

Command line script for updating the TC database.

geoips.commandline.update_tc_tracks_database.main()[source]#

Update TC tracks database via command line.

Module contents#

geoips.commandline init file.