ncsw_data.source.base.utility.download
======================================

.. py:module:: ncsw_data.source.base.utility.download

.. autoapi-nested-parse::

   The ``ncsw_data.source.base.utility`` package ``download`` module. 



Classes
-------

.. autoapisummary::

   ncsw_data.source.base.utility.download.DataSourceDownloadUtility


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

.. py:class:: DataSourceDownloadUtility

   The data source download utility class. 


   .. py:method:: send_http_get_request(http_get_request_url: str, **kwargs) -> requests.Response
      :staticmethod:


      Send an HTTP GET request.

      :parameter http_get_request_url: The URL of the HTTP GET request.
      :parameter kwargs: The keyword arguments for the adjustment of the following underlying functions:
          { `requests.api.get` }.

      :returns: The response to the HTTP GET request.



   .. py:method:: download_file(file_url: str, file_name: str, output_directory_path: Union[str, os.PathLike[str]]) -> None
      :staticmethod:


      Download a file.

      :parameter file_url: The URL of the file.
      :parameter file_name: The name of the file.
      :parameter output_directory_path: The path to the output directory where the file should be downloaded.