nyx_client.configuration
========================

.. py:module:: nyx_client.configuration

.. autoapi-nested-parse::

   SDK configuration classes.



Classes
-------

.. autoapisummary::

   nyx_client.configuration.BaseNyxConfig
   nyx_client.configuration.ConfigType
   nyx_client.configuration.NyxConfigExtended


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

.. py:class:: BaseNyxConfig

   Configuration for the Nyx client.

   .. attribute:: nyx_url

      The URL of the Nyx instance.

   .. attribute:: nyx_username

      The username of the Nyx user.

   .. attribute:: nyx_email

      The email of the Nyx user.

   .. attribute:: nyx_password

      The password of the Nyx user.


   .. py:method:: from_env(env_file = None, override_token = None)
      :classmethod:


      Create a BaseNyxConfig instance from environment variables.

      :param env_file: Path to the environment file.
      :param override_token: Token to override the default authentication.

      :returns: A new BaseNyxConfig instance.

      :raises OSError: If required environment variables are not set.



   .. py:method:: __str__()

      Return a string representation of the configuration.

      :returns: A JSON string of the configuration.



   .. py:property:: nyx_auth
      :type: dict

      Get the authentication credentials.

      :returns: A dictionary containing email and password for authentication.


.. py:class:: ConfigType

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Nyx configuration types.


.. py:class:: NyxConfigExtended

   Extended configuration for Nyx client with API integration.

   .. attribute:: api_key

      The API key for the selected provider.

   .. attribute:: provider

      The type of configuration provider.

   .. attribute:: base_config

      The base Nyx configuration.


   .. py:method:: from_env(provider, env_file = None, override_token = None)
      :classmethod:


      Create a NyxConfigExtended instance from environment variables.

      :param provider: The type of configuration provider.
      :param env_file: Path to the environment file.
      :param override_token: Token to override the default authentication.

      :returns: A new NyxConfigExtended instance.

      :raises Exception: If an unsupported config type is provided.