:py:mod:`SBTi.data.csv`
=======================

.. py:module:: SBTi.data.csv


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

Classes
~~~~~~~

.. autoapisummary::

   SBTi.data.csv.CSVProvider




.. py:class:: CSVProvider(path: str, path_targets: str, encoding: str = 'utf-8')

   Bases: :py:obj:`SBTi.data.data_provider.DataProvider`

   Data provider skeleton for CSV files. This class serves primarily for testing purposes only!

   :param config: A dictionary containing a "path" field that leads to the path of the CSV file

   .. py:method:: get_targets(self, company_ids: list) -> List[SBTi.interfaces.IDataProviderTarget]

      Get all relevant targets for a list of company ids (ISIN). This method should return a list of
      IDataProviderTarget instances.

      :param company_ids: A list of company IDs (ISINs)
      :return: A list containing the targets


   .. py:method:: _target_df_to_model(self, df_targets)

      transforms target Dataframe into list of IDataProviderTarget instances

      :param df_targets: pandas Dataframe with targets
      :return: A list containing the targets


   .. py:method:: get_company_data(self, company_ids: list) -> List[SBTi.interfaces.IDataProviderCompany]

      Get all relevant data for a list of company ids (ISIN). This method should return a list of IDataProviderCompany
      instances.

      :param company_ids: A list of company IDs (ISINs)
      :return: A list containing the company data


   .. py:method:: get_sbti_targets(self, companies: list) -> list

      For each of the companies, get the status of their target (Target set, Committed or No target) as it's known to
      the SBTi.

      :param companies: A list of companies. Each company should be a dict with a "company_name" and "company_id"
                          field.
      :return: The original list, enriched with a field called "sbti_target_status"