arctichoke.verify
=================

.. py:module:: arctichoke.verify


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/arctichoke/verify/verify_path/index


Functions
---------

.. autoapisummary::

   arctichoke.verify.verify_path


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

.. py:function:: verify_path(path)

   Verify that the filepath exists.

   Check if the path to the data files exists and is valid.
   If not, raise an error.

   :param path: Relative path to the directory containing data files.
   :type path: `str`

   :raises FileNotFoundError: If the specified path does not exist.

   :returns: **path** -- The verified path to the data files.
   :rtype: `str`

   .. rubric:: Examples

   >>> verify_path('README.md')
   'README.md'