api_24sea.datasignals.base_client
=================================

.. py:module:: api_24sea.datasignals.base_client

.. autoapi-nested-parse::

   Shared authentication state for the DataSignals client facades.



Classes
-------

.. autoapisummary::

   api_24sea.datasignals.base_client.DataSignalsClient


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

.. py:class:: DataSignalsClient



   Provide state and authentication shared by both client facades.

   This base contains no data-retrieval endpoint methods. Synchronous and
   asynchronous endpoint calls remain owned by their respective facades.


   .. py:property:: base_url
      :type: str


      Return the normalized DataSignals API base URL.



   .. py:property:: authenticated
      :type: bool


      Return whether the client is authenticated.



   .. py:property:: metrics_overview
      :type: Optional[pandas.DataFrame]


      Return the metrics overview DataFrame.



   .. py:method:: authenticate(username: str, password: str, permissions_overview: Optional[pandas.DataFrame] = None)

      Authenticate with username and password.



   .. py:method:: selected_metrics(data: pandas.DataFrame) -> pandas.DataFrame

      Return metrics represented by columns in ``data``.