lories.io.csv
=============

.. py:module:: lories.io.csv

.. autoapi-nested-parse::

   lories.io.csv
   ~~~~~~~~~~~~~




Functions
---------

.. autoapisummary::

   lories.io.csv.read_file


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

.. py:function:: read_file(path: str, index_column: str = 'Timestamp', index_type: str = 'Timestamp', timezone: Optional[pytz.tzinfo] = None, separator: str = ',', decimal: str = '.', rename: Optional[Mapping[str, str]] = None, encoding: str = 'utf-8-sig') -> pandas.DataFrame

   Reads the content of a specified CSV file.

   :param path:
       the full path to the CSV file.
   :type path:
       string

   :param index_column:
       the column name of the CSV file index.
   :type index_column:
       string

   :param index_type:
       the index type, either "Timestamp", "UNIX" oder "None".
   :type index_type:
       string

   :param separator:
       the separator character of the CSV file.
   :type separator:
       string

   :param decimal:
       the decimal character used for the CSV file.
   :type decimal:
       string

   :param timezone:
       the timezone for the timestamp to be converted or localized to.
   :type timezone:
       :class: `pytz.tzinfo`

   :param rename:
       the dictionary to rename columns by after reading, if not None.
   :type rename:
       dict

   :param encoding:
       the encoding to read_file the file with.
   :type encoding:
       string


   :returns:
       the retrieved columns, indexed by their timestamp
   :rtype:
       :class:`pandas.DataFrame`