Package kenozooid :: Package cli

Package cli

Commmand line user interface.

Submodules
kenozooid.cli.calc: Kenozooid calculator commands. kenozooid.cli.da: Kenozooid's plotting and data analysis command line user interface. kenozooid.cli.dc: Dive computer related Kenozooid command line commands. kenozooid.cli.logbook: Kenozooid's logbook command line user interface. kenozooid.cli.plan: Kenozooid dive planning commands.

Classes
	CLICommand Kenozooid's command.
	ArgumentError Error to indicate incorrect Kenozooid command arguments.
	NoCommandError No Kenozooid command specified.
	UDDFInputAction Parse arguments being a list of UDDF input files with '-k' option per input file.

Functions

add_commands(parser, prefix=None, title=None)
Find and add commands to the argument parser.

source code

add_master_command(name, title, desc)
Add master command.

source code

add_uddf_input(parser)
Add list of UDDF files as input argument to a parser.

source code

Variables
	__package__ = `'kenozooid.cli'`

Function Details

Find and add commands to the argument parser.

Parameters:

Add master command.

The purpose of master command is to

group other commands as sub-commands, i.e. 'dive' master command for 'list' and 'add' sub-commands means there are 'dive list' and 'dive add' commands.
provide help title and generalized help description of groupped sub-commands

Parameters:

Add list of UDDF files as input argument to a parser.

The function adds several options and arguments

-n is added to fetch dives by their number
multiple UDDF files can be specified
each file can be preceded with -k option to indicate which dives should be fetched from a file

The -k and -n options are glued with 'and' operator - use only one of them if confused.

Parameters: