foliolib.okapi.okapiModule.OkapiModule

class foliolib.okapi.okapiModule.OkapiModule(module: Union[dict, str])

Bases: object

Defines an okapi module.

Parameters

module (Union[dict, str]) – ModuleDescriptor or Module id, e.g. mod-users-17.1.0

Methods

get_descriptor()	Get ModuleDescriptor
get_docker_args()
get_docker_image()	Get docker image name
get_env()
get_id()	Get module name
get_provides()	Get provides
get_requires()	Get requirements for the module
has_launchDescriptor()
has_requirement(require)

get_descriptor()

Get ModuleDescriptor

Returns

ModuleDescriptor

Return type

dict

get_docker_args()

get_docker_image()

Get docker image name

Returns

Get the name of the docker image

Return type

str

get_env()

get_id()

Get module name

Returns

Module name

Return type

str

get_provides()

Get provides

Returns

Provides

Return type

list

get_requires()

Get requirements for the module

Returns

Requirements

Return type

list

has_launchDescriptor()

has_requirement(require: str)