3.1. karr_lab_quilt3_manager package

3.1.1. Submodules

3.1.2. karr_lab_quilt3_manager.__main__ module

karr_lab_quilt3_manager command line interface

Author:Name <email> Date:2019-9-12 Copyright:2019, Karr Lab License:MIT

class karr_lab_quilt3_manager.__main__.App(label=None, **kw)

Bases: cement.core.foundation.App

Command line application

class Meta

Bases: object

base_controller = 'base'

handlers = [<class 'karr_lab_quilt3_manager.__main__.BaseController'>, <class 'karr_lab_quilt3_manager.__main__.Command3WithArgumentsController'>]

label = 'karr_lab_quilt3_manager'

class karr_lab_quilt3_manager.__main__.BaseController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Base controller for command line application

class Meta

Bases: object

arguments = [(['-v', '--version'], {'action': 'version', 'version': '0.0.1'})]

description = 'karr_lab_quilt3_manager'

label = 'base'

cmd1()

command_1 description

cmd2()

command_2 description

class karr_lab_quilt3_manager.__main__.Command3WithArgumentsController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Command3 description

class Meta

Bases: object

arguments = [(['arg_1'], {'type': <class 'str'>, 'help': 'Description of arg_1'}), (['arg_2'], {'type': <class 'str'>, 'help': 'Description of arg_2'}), (['--opt-arg-3'], {'type': <class 'str'>, 'default': 'default value of opt-arg-1', 'help': 'Description of opt-arg-3'}), (['--opt-arg-4'], {'type': <class 'float'>, 'default': nan, 'help': 'Description of opt-arg-4'})]

description = 'Command3 description'

label = 'command-3'

stacked_on = 'base'

stacked_type = 'nested'

karr_lab_quilt3_manager.__main__.main()

3.1.3. karr_lab_quilt3_manager.core module

karr_lab_quilt3_manager

Author:Name <email> Date:2019-9-12 Copyright:2019, Karr Lab License:MIT

class karr_lab_quilt3_manager.core.ExampleClass(arg_1, arg_2, kwarg_1=None, kwarg_2=None)

Bases: object

Descipton of ExampleClass

attr_1

description of attr_1

Type:type of attr_1

attr_2

description of attr_2

Type:type of attr_2

...

method_1(arg_1, arg_2, kwarg_1=None, kwarg_2=None)

Description of method_1

Parameters:

• arg_1 (type of arg_1) – description of arg_1
• arg_2 (type of arg_2) – description of arg_2
• kwarg_1 (type of kwarg_1, optional) – description of kwarg_1
• kwarg_2 (type of kwarg_2, optional) – description of kwarg_2
• .. –

Returns:

description of return value

Return type:

type of return value

Raises:

:obj:`type of raised exception(s)` – description of raised exceptions

3.1.4. Module contents