:py:mod:`sovabids.loggers`
==========================

.. py:module:: sovabids.loggers

.. autoapi-nested-parse::

   Module dealing with logging related functionality and settings



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


Functions
~~~~~~~~~

.. autoapisummary::

   sovabids.loggers._excepthook
   sovabids.loggers.setup_logging



.. py:function:: _excepthook(*args)

   Catch Exceptions to logger.

   .. rubric:: Notes

   See https://code.activestate.com/recipes/577074-logging-asserts/


.. py:function:: setup_logging(log_file=None, debug=False)

   Setup the logging

   :param log_file: Name of the logfile
   :type log_file: str
   :param debug: Set log level to DEBUG if debug==True
   :type debug: bool

   :returns: The logger.
   :rtype: logging.logger

   .. rubric:: Notes

   This function is a copy of the one found in bidscoin.
   https://github.com/Donders-Institute/bidscoin/blob/748ea2ba537b06d8eee54ac7217b909bdf91a812/bidscoin/bidscoin.py#L41-L83