friendlypins.scripts.fpins module¶

Command line interface for the friendly pins APIs

friendlypins.scripts.fpins.configure_logging(verbosity)[source]¶

Configures the global logger for the application

Parameters: verbosity (int) – numeric value for the verbosity level for the log the larger the number, the more verbose the output

friendlypins.scripts.fpins.get_args(args)[source]¶

Helper method used to parse command line parameters

Parameters: args (str) – optional command line arguments to be parsed if not provided, args will be parsed from the console
Returns: parsed arguments
Return type: argparse.ArgumentParser

friendlypins.scripts.fpins.main(args=None)[source]¶

Entry point function

Parameters: args (str) – sample command line parameters to use when launching the tool used for debug and testing purposes only When not provided, arguments will be parsed from the command line
Returns: error code produced by completing the given operation
Return type: int