mypackage.api module

mypackage.api.run(config_file: Union[str, PathLike[str]], option: bool = False)

Run the mypackage process.

Run the mypackage process and .. (long description).

Parameters:

• config_file (Union[str, os.PathLike[str]]) – file containing the mypackage configuration

• option (bool, optional) – if True, does something differently, by default False

Raises:

FileNotFoundError – if config_file does not exist

class mypackage.api.MyPackageProcess(config_file: Path)

Bases: object

run()

Run the mypackage process.

Runs the mypackage process in a self-terminated loop.

property run_number: int

Example for a read only property.

property max_number_of_runs: int

Example for a read/write property implemented through a pair of explicit getter and setter methods (see below for the related setter method).