nmk_badges.builder

Python module for nmk-badges builders.

Module Contents

Classes

NmkBadgesBuilder

Builder for badges task.
class nmk_badges.builder.NmkBadgesBuilder(model: nmk.model.model.NmkModel)

Bases: nmk.model.builder.NmkTaskBuilder

Builder for badges task.

build(badges: List[Dict[str, str]], begin_pattern: str, end_pattern: str)

Build logic for badges task:

  • looks for the begin/end patterns in the input file

  • replace lines between them by generated ones for configured badges

  • skip badges when “if” or “unless” condition is not met

  • touch the output stamp file

Parameters:

  • badges – List of configured badges to be inserted

  • begin_pattern – Begin pattern to look for in input file

  • end_pattern – End pattern to look for in input file