:py:mod:`sovabids.files`
========================

.. py:module:: sovabids.files

.. autoapi-nested-parse::

   Module with file utilities.



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


Functions
~~~~~~~~~

.. autoapisummary::

   sovabids.files._get_files
   sovabids.files._write_yaml
   sovabids.files.download



.. py:function:: _get_files(root_path)

   Recursively scan the directory for files, returning a list with the full-paths to each.

   :param root_path: The path we want to obtain the files from.
   :type root_path: str

   :returns: **filepaths** -- A list containing the path to each file in root_path.
   :rtype: list of str


.. py:function:: _write_yaml(dictionary, path=None)

   Write a yaml file based on the dictionary to the specified path.

   :param dictionary: The dictionary to be written.
   :type dictionary: dict
   :param path: Full path to the yaml file to be written. If None, no file will be written.
   :type path: str | None

   :returns: The dump version of the generated yaml document.
   :rtype: str


.. py:function:: download(url, path)

   Download in the path the file from the given url.

   From H S Umer farooq answer at https://stackoverflow.com/questions/22676/how-to-download-a-file-over-http

   :param url: The url of the file to download.
   :type url: str
   :param path: The path where to download the file.
   :type path: str