nmk_base.helpers
================

.. py:module:: nmk_base.helpers

.. autoapi-nested-parse::

   Python module for **nmk-base** helper tasks.



Classes
-------

.. autoapisummary::

   nmk_base.helpers.InfoBuilder
   nmk_base.helpers.VersionBuilder
   nmk_base.helpers.HelpBuilder
   nmk_base.helpers.TaskListBuilder


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

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

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


   Common implementation for information display tasks


   .. py:method:: display_info(info: dict[str, str])

      Iterate on information dictionnary content, and display it with aligned colons

      :param info: Information dictionnary



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

   Bases: :py:obj:`InfoBuilder`


   Builder implementation for **version** task


   .. py:method:: build(plugins: dict[str, str])

      Build logic for **version** task:
      iterate on provided plugins version map and display them.

      :param plugins: Map of plugins versions



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

   Bases: :py:obj:`InfoBuilder`


   Builder implementation for **help** task


   .. py:method:: build(links: dict[str, str])

      Build logic for **help** task:
      iterate on provided plugins help links map and display them.

      :param links: Map of plugins help links



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

   Bases: :py:obj:`InfoBuilder`


   Builder implementation for **tasks** task


   .. py:method:: build()

      Build logic for **tasks** task:
      iterate on build model tasks, and display them (with their emoji and description text)