nmk_badges.builder
==================

.. py:module:: nmk_badges.builder

.. autoapi-nested-parse::

   Python module for **nmk-badges** builders.



Classes
-------

.. autoapisummary::

   nmk_badges.builder.NmkBadgesBuilder


Module Contents
---------------

.. py:class:: NmkBadgesBuilder(model: nmk.model.model.NmkModel)

   Bases: :py:obj:`nmk.model.builder.NmkTaskBuilder`


   Builder for **badges** task.


   .. py:method:: 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

      :param badges: List of configured badges to be inserted
      :param begin_pattern: Begin pattern to look for in input file
      :param end_pattern: End pattern to look for in input file