IHEWAcollect.scripts package

Submodules

IHEWAcollect.scripts.credential module

IHEWAcollect.scripts.main module

Main command group for WaterAccounting Collect’s CLI.

IHEWAcollect.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!

IHEWAcollect.scripts.skeleton.fib(n)

Fibonacci example function

Parameters:

n (int) – integer

Returns:

n-th Fibonacci number

Return type:

int

IHEWAcollect.scripts.skeleton.main(args)

Main entry point allowing external calls

Parameters:

args ([str]) – command line parameter list

IHEWAcollect.scripts.skeleton.parse_args(args)

Parse command line parameters

Parameters:

args ([str]) – command line parameters as list of strings

Returns:

command line parameters namespace

Return type:

argparse.Namespace

IHEWAcollect.scripts.skeleton.run()

Entry point for console_scripts

IHEWAcollect.scripts.skeleton.setup_logging(loglevel)

Setup basic logging

Parameters:

loglevel (int) – minimum loglevel for emitting messages

Module contents

IHEWAcollect script modules