IHEWAengine.scripts package¶

Submodules¶

IHEWAengine.scripts.main module¶

Main command group for WaterAccounting Engine’s CLI.

IHEWAengine.scripts.skeleton module¶

This is a skeleton file that can serve as a starting point for a Python console script. To run this script uncomment the following lines in the [options.entry_points] section in setup.cfg:

console_scripts =
fibonacci = IHEWAcollect.skeleton:run

Then run python setup.py install which will install the command fibonacci inside your current environment. Besides console scripts, the header (i.e. until _logger…) of this file can also be used as template for Python modules.

Note

This skeleton file can be safely removed if not needed!

IHEWAengine.scripts.skeleton.fib(n)[source]¶

Fibonacci example function

Parameters: n (int) – integer
Returns: n-th Fibonacci number
Return type: int

IHEWAengine.scripts.skeleton.main(args)[source]¶

Main entry point allowing external calls

Parameters: args ([str]) – command line parameter list

IHEWAengine.scripts.skeleton.parse_args(args)[source]¶

Parse command line parameters

Parameters: args ([str]) – command line parameters as list of strings
Returns: command line parameters namespace
Return type: argparse.Namespace

IHEWAengine.scripts.skeleton.run()[source]¶: Entry point for console_scripts

IHEWAengine.scripts.skeleton.setup_logging(loglevel)[source]¶

Setup basic logging

Parameters: loglevel (int) – minimum loglevel for emitting messages

Module contents¶

IHEWAengine script modules