package reference

Config

pyhectiqlab.Config

classConfig(**kwargs)

Initialize a configuration object. Returns a Config.

Property	Type	Default	Description
`**kwargs`		`-`	Any type of iterable parameter

@classmethodConfig.from_dict(data: dict)

Initialize a configuration object with the content of a dictionary. Returns a Config.

Property	Type	Default	Description
`data`	`dict`	`-`	A dictionary object with the data

@staticmethodConfig.download(run: str, project: str)

Download the config object and the meta informations from an existing run. Returns a tuple with the (Config, dict)

Property	Type	Default	Description
`run`	`str`	`-`	The slugified run name
`project`	`str`	`-`	The project name

@classmethodConfig.load(path: str)

Load the config from a json format on your machine. Returns a Config object.

Property	Type	Default	Description
`path`	`str`	`-`	Local path to the config dump.

Config.lock()

Disable the settings attributes. The config becomes immuable.

Config.unlock()

Enable settings the attributes. The config becomes muable.

Config.save(path: str)

Write the config in a json format on your local drive.

Property	Type	Default	Description
`path`	`str`	`-`	Local path to the config dump.

@classmethodConfigTemplate.help()

Print in a json format the description to initialize the object.

@classmethodConfigTemplate.to_config(store_description: bool = False)

Initialize a configuration object with the attributes of the objet. Returns a Config.

Property	Type	Default	Description
`store_description`	`bool`	`False`	Set to true to store the parameters description into `__help__`