installation_instruction
========================

.. py:module:: installation_instruction


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/installation_instruction/__main__/index
   /autoapi/installation_instruction/get_flags_and_options_from_schema/index
   /autoapi/installation_instruction/helpers/index
   /autoapi/installation_instruction/installation_instruction/index


Attributes
----------

.. autoapisummary::

   installation_instruction.__version__
   installation_instruction.__description__
   installation_instruction.__repository__
   installation_instruction.__author__
   installation_instruction.__author_email__
   installation_instruction.__license__


Classes
-------

.. autoapisummary::

   installation_instruction.InstallationInstruction


Package Contents
----------------

.. py:data:: __version__

.. py:data:: __description__

.. py:data:: __repository__

.. py:data:: __author__

.. py:data:: __author_email__

.. py:data:: __license__

.. py:class:: InstallationInstruction(config: str)

   Class holding schema and template for validating and rendering installation instruction.


   .. py:method:: validate_and_render(input: dict) -> tuple[list[str], bool]

      Validates user input against schema and renders with the template.
      Returns installation instructions and False. 
      If jinja macro `raise` is called returns error message and True.

      :param input: Enduser input.
      :ptype input: dict
      :return: Returns instructions as string and False. Or Error and True.
      :rtpye: (str, bool)
      :raise Exception: If schema or user input is invalid.



   .. py:method:: parse_schema() -> dict

      Parses schema into a dict.

      This is only important for merging enum, anyOf and oneOf into one type.

      :return: Schema as dict.
      :rtype: dict



   .. py:attribute:: template


   .. py:method:: from_file(path: str)
      :classmethod:


      Returns class initialized via config file from path.

      :param path: Path to config file.
      :ptype path: str
      :return: InstallationInstruction class
      :rtype: InstallationInstruction