installation_instruction.__main__
=================================

.. py:module:: installation_instruction.__main__

.. autoapi-nested-parse::

   Code of the click custom commands `install`, `show` and `default`.
   The commands `install` and `show` are ConfigReadCommand instances
   while the subcommands `add`, `remove` and `list` from the multi command default 
   are ConfigCommandGroup instances.



Attributes
----------

.. autoapisummary::

   installation_instruction.__main__.VERSION_STRING


Classes
-------

.. autoapisummary::

   installation_instruction.__main__.ConfigReadCommand
   installation_instruction.__main__.ConfigCommandGroup


Functions
---------

.. autoapisummary::

   installation_instruction.__main__._get_system
   installation_instruction.__main__.cat
   installation_instruction.__main__.show
   installation_instruction.__main__.install
   installation_instruction.__main__.default
   installation_instruction.__main__.add
   installation_instruction.__main__.remove
   installation_instruction.__main__.list
   installation_instruction.__main__.main


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

.. py:data:: VERSION_STRING

.. py:function:: _get_system(option_types)

   Returns the os from the list of possible os systems defined in the schema.

   :param option_types: list of system from the schema.
   :type option_types: list
   :return: os system from input list or None.
   :rtype: string or None


.. py:class:: ConfigReadCommand(*args, **kwargs)

   Bases: :py:obj:`click.MultiCommand`


   Custom click command class to read config file, folder or git repository and show installation instructions with parameters.


   .. py:method:: get_command(ctx, config_file: str) -> click.Command | None

      Given a context and a command name, this returns a
      :class:`Command` object if it exists or returns `None`.



.. py:class:: ConfigCommandGroup(*args, **kwargs)

   Bases: :py:obj:`click.Group`


   Custom click command group class for default commands with subcommands.


   .. py:method:: get_command(ctx, config_file: str, **kwargs) -> click.Command | None

      Given a context and a command name, this returns a
      :class:`Command` object if it exists or returns `None`.



.. py:function:: cat(path)

.. py:function:: show(ctx)

.. py:function:: install(ctx, verbose)

.. py:function:: default(ctx)

.. py:function:: add(ctx)

.. py:function:: remove(ctx)

.. py:function:: list(ctx)

.. py:function:: main(ctx)