ncsw_data.source.base
=====================

.. py:module:: ncsw_data.source.base

.. autoapi-nested-parse::

   The ``ncsw_data.source.base`` package initialization module. 



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ncsw_data/source/base/base/index
   /autoapi/ncsw_data/source/base/utility/index


Classes
-------

.. autoapisummary::

   ncsw_data.source.base.DataSourceBase


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

.. py:class:: DataSourceBase(logger: Optional[logging.Logger] = None)

   Bases: :py:obj:`abc.ABC`


   The data source base class. 

   The `__init__` method of the class.

   :parameter logger: The logger. The value `None` indicates that the logger should not be utilized.


   .. py:property:: logger
      :type: Optional[logging.Logger]


      Get the value of the logger.

      :returns: The value of the logger.



   .. py:method:: download(**kwargs) -> None
      :abstractmethod:


      Download the data from the data source. 



   .. py:method:: extract(**kwargs) -> None
      :abstractmethod:


      Extract the data from the data source. 



   .. py:method:: format(**kwargs) -> None
      :abstractmethod:


      Format the data from the data source.