Metadata-Version: 2.4
Name: ka_uts_eco
Version: 2.2.0.250416
Summary: EcoVadis Utilities
Author-email: Bernd Stroehle <bernd.stroehle@gmail.com>
Maintainer-email: Bernd Stroehle <bernd.stroehle@gmail.com>
License-Expression: GPL-3.0-only WITH Classpath-exception-2.0 OR BSD-3-Clause
Project-URL: Source Code, https://github.com/bs2910/ka_uts_eco/tree/master
Project-URL: Homepage, https://kosakya.de/
Project-URL: Documentation, https://ka_uts_eco.readthedocs.io/en/latest
Project-URL: Apache-2.0 License, https://apache.org/licenses/LICENSE-2.0
Project-URL: GPLv3 License, https://www.gnu.org/licenses/gpl-3.0.en.html
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Natural Language :: English
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: geopy>=2.4.1
Requires-Dist: ka_uts_arr>=2.1.0.250408
Requires-Dist: ka_uts_dfr>=2.1.0.250408
Requires-Dist: ka_uts_dic>=2.1.0.250408
Requires-Dist: ka_uts_log>=2.1.1.250415
Requires-Dist: numpy>=2.2.4
Requires-Dist: pandas>=2.2.3
Requires-Dist: postal_codes_tools>=1.1.3
Requires-Dist: pycountry>=24.6.1
Dynamic: license-file

##########
ka_uts_eco
##########

Overview
********

.. start short_desc

**EcoVadis IQ Processor**

.. end short_desc

Installation
************

.. start installation

The Python Package ``ka_uts_eco`` can be installed from PyPI or Anaconda.

To install with ``pip``:

.. code-block:: shell

	$ python -m pip install ka_uts_eco

To install with ``conda``:

.. code-block:: shell

	$ conda install -c conda-forge ka_uts_eco

.. end installation

Package ka_uts_eco
******************

Classification
==============

The Files of Package ``ka_uts_eco`` could be classified into the follwing file types:

#. *Special package files*; c.f.: **Appendix: Special package files**

   a. *py.typed*

#. *Special package modules*; **Appendix: Special package modules**

   a. *__init__.py*
   #. *__version__.py*

#. *Package modules*

   a. **utils.py**

Module: utils.py
================

Classes
-------

The Module ``utils.py`` contains the the follwing static classes.

  .. utils.py-classes-label:
  .. table:: utils.py classes*

   +--------+---------------------------------------+
   |Name    |Description                            |
   +========+=======================================+
   |Evup    |Manage EcoVadis upload workbook        |
   +--------+---------------------------------------+
   |Evex    |Manage EcoVadis export workbook        |
   +--------+---------------------------------------+
   |Evin    |Manage EcoVadis inputworkbook (provided|
   |        |by external systems like OmniTracker)  |
   +--------+---------------------------------------+
   |EvinEvex|Check EcoVadis input workbook against  |
   |        |EcoVadis export workbook               |
   +--------+---------------------------------------+
   |EvexEvin|Check EcoVadis Export workbook against |
   |        |EcoVadis input workbook                |
   +--------+---------------------------------------+

Class: Evup
-----------

The static Class ``Evup`` contains the subsequent methods.

Evup: Methods
^^^^^^^^^^^^^

  .. Evup-methods-label:
  .. table:: Evup methods*

   +---------------+--------------------------------------------------------------+
   |Name           |Description                                                   |
   +===============+==============================================================+
   |sh_aod_evup_adm|Create and show the array of dictionaries for given dictionary|
   |               |of arrays of dictionaries and given operation by applying the |
   |               |union function to the array of dictionaries.                  |
   +---------------+--------------------------------------------------------------+

Class: Evex
-----------

The static Class ``Evex`` contains the subsequent methods.

Evex: Methods
^^^^^^^^^^^^^

  .. Evex-methods-label:
  .. table:: Evex methods*

   +----------------------+-----------------------------------------------------+
   |Name                  |Description                                          |
   +======================+=====================================================+
   |sh_d_evex             |Migrate an EcoVadis export dataframe to a dictionary.|
   +----------------------+-----------------------------------------------------+
   |sh_d_evup_del_from_dic|Migrate an EcoVadis export dictionary to a dictionary|
   |                      |for the EcoVadis upload delete sheet.                |
   +----------------------+-----------------------------------------------------+
   |sh_d_evup_del_from_df |Migrate an EcoVadis export dataframe row to a        |
   |                      |dictionary for the EcoVadis upload delete sheet.     |
   +----------------------+-----------------------------------------------------+
   |map                   |Map the EcoVadis IQ sustainability risk rating in the|
   |                      |array of EcoVadis disk dictionaries to the risk      |
   |                      |rating defined by UMH.                               |
   +----------------------+-----------------------------------------------------+

Class: Evin
-----------

The static Class ``Evin`` contains the subsequent methods.

Evin: Methods
^^^^^^^^^^^^^

  .. Evin-methods-label:
  .. table:: Evin methods*

   +----------------------------+-----------------------------------------------------+
   |Name                        |Description                                          |
   +============================+=====================================================+
   |sh_d_evup_adm               |Migrate an OmniTracker export dictionary to a        |
   |                            |EcoVadis upload dictionary.                          |
   +----------------------------+-----------------------------------------------------+
   |sh_aod_evup_adm             |Migrate an array of OmniTracker export dictionaries  |
   |                            |to an array of EcoVadis upload dictionaries.         |
   +----------------------------+-----------------------------------------------------+
   |verify_duns                 |Verify the field 'DUNS-Nummer' for all dictionaries  |
   |                            |of the given array of OmniTracker export dictionaries|
   |                            |if the verification is requested.                    |
   +----------------------------+-----------------------------------------------------+
   |verify_objectid             |Verify the field 'Eindeutige ID' for all dictionaries|
   |                            |of the given array of OmniTracker export dictionaries|
   |                            |if the verification is requested.                    |
   +----------------------------+-----------------------------------------------------+
   |verify_countrycode          |Verify the field 'Landesvorwahl' for all dictionaries|
   |                            |of the given array of OmniTracker export dictionaries|
   |                            |if the verification is requested.                    |
   +----------------------------+-----------------------------------------------------+
   |verify_town_in_country      |Verify the field 'Stadt' together with the field     |
   |                            |'Landesvorwahl' for all dictionaries of the given    | 
   |                            |array of OmniTracker export dictionaries if the      |
   |                            |verification is requested.                           |
   +----------------------------+-----------------------------------------------------+
   |verify_postalcode_in_country|Verify the field 'Postleitzahl' together with the    |
   |                            |field 'Landesvorwahl' for all dictionaries of the    |
   |                            |given array of OmniTracker export dictionaries if the|
   |                            |verification is requested.                           |
   +----------------------------+-----------------------------------------------------+
   |verify                      |Verify all fields of all dictionaries of the given   |
   |                            |array of OmniTracker export dictionaries if the      |
   |                            |verification is requested and return the verification|
   |                            |status controlled by the verify ignore switches.     |
   +----------------------------+-----------------------------------------------------+
   |verify_aod_evin             |Apply the verify function to all dictionaries of the |
   |                            |array of Omnitracker export dictionaries.            |
   +----------------------------+-----------------------------------------------------+
   |sh_doaod_adm_new            |Migrate array of Omnitracker export dictionaries     |
   |                            |to dictionary of array of EcoVadis upload            |
   |                            |dictionaries for Admin processing                    |
   +----------------------------+-----------------------------------------------------+

Class: EvexEvin
---------------

The static Class ``EvexEvin`` contains the subsequent methods.

EvexEvin: Methods
^^^^^^^^^^^^^^^^^

  .. EvexEvin-methods-label:
  .. table:: EvexEvin methods*

   +--------+--------------------------------------------------------------+
   |Name    |Description                                                   |
   +========+==============================================================+
   |join_del|Join the Array of EcoVadis export dictionaries with the       |
   |        |dataframe of OmniTracker export records for delete processing.| 
   +--------+--------------------------------------------------------------+

Class: EvinEvex
---------------

The static Class ``EvinEvex`` contains the subsequent variables and methods.

EvinEvex: Variables
^^^^^^^^^^^^^^^^^^^

  .. EvinEvex-variabless-label:
  .. table:: EvinEvex variables*

   +--------+-----------------------------------------------------------------------+
   |Name    |Description                                                            |
   +========+=======================================================================+
   |msg_evex|Message that could be displayed when processing the EcoVadis export.   |
   +--------+-----------------------------------------------------------------------+
   |msg_evin|Message that could be displayed when processing the OmniTracker export.|
   +--------+-----------------------------------------------------------------------+

EvinEvex: Methods
^^^^^^^^^^^^^^^^^

  .. EvinEvex-methods-label:
  .. table:: EvinEvex methods*

   +---------------+-----------------------------------------------------------+
   |Name           |Description                                                |
   +===============+===========================================================+
   |query_with_keys|Query EcoVadis dataframe with multiple keys and country    |
   |               |code until row is found and return row.                    |
   +---------------+-----------------------------------------------------------+
   |query          |Query EcoVadis dataframe with OmniTracker export keys:     |
   |               |'Eindeutige ID' or 'DUNS-Nummer' or keys form array of keys|
   |               |until row is found.                                        |
   +---------------+-----------------------------------------------------------+
   |join_adm       |Join the Array of OmniTracke export dictionaries with the  |
   |               |dataframe of EcoVadis export records for admin processing. | 
   +---------------+-----------------------------------------------------------+
   |join_del       |Join the Array of OmniTracke export dictionaries with the  |
   |               |dataframe of EcoVadis export records for delete processing.| 
   +---------------+-----------------------------------------------------------+
   |sh_d_evup_adm  |Show change status and EcoVadis upload dictionary for      |
   |               |OmniTracker export- and EcoVadis export-dictionary         |
   +---------------+-----------------------------------------------------------+

Appendix
********

Package Logging
===============

Description
-----------

The Standard or user specifig logging is carried out by the log.py module of the logging
package ka_uts_log using the configuration files **ka_std_log.yml** or **ka_usr_log.yml**
in the configuration directory **cfg** of the logging package **ka_uts_log**.
The Logging configuration of the logging package could be overriden by yaml files with
the same names in the configuration directory **cfg** of the application packages.

Log message types
-----------------

Logging defines log file path names for the following log message types: .

#. *debug*
#. *info*
#. *warning*
#. *error*
#. *critical*

Application parameter for logging
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  .. Application-parameter-used-in-log-naming-label:
  .. table:: *Application parameter used in log naming*

   +-----------------+---------------------------+----------+------------+
   |Name             |Decription                 |Values    |Example     |
   +=================+===========================+==========+============+
   |dir_dat          |Application data directory |          |/otev/data  |
   +-----------------+---------------------------+----------+------------+
   |tenant           |Application tenant name    |          |UMH         |
   +-----------------+---------------------------+----------+------------+
   |package          |Application package name   |          |otev_xls_srr|
   +-----------------+---------------------------+----------+------------+
   |cmd              |Application command        |          |evupreg     |
   +-----------------+---------------------------+----------+------------+
   |pid              |Process ID                 |          |æevupreg    |
   +-----------------+---------------------------+----------+------------+
   |log_ts_type      |Timestamp type used in     |ts,       |ts          |
   |                 |logging files|ts, dt       |dt        |            |
   +-----------------+---------------------------+----------+------------+
   |log_sw_single_dir|Enable single log directory|True,     |True        |
   |                 |or multiple log directories|False     |            |
   +-----------------+---------------------------+----------+------------+

Log type and Log directories
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Single or multiple Application log directories can be used for each message type:

  .. Log-types-and-Log-directories-label:
  .. table:: *Log types and directoriesg*

   +--------------+---------------+
   |Log type      |Log directory  |
   +--------+-----+--------+------+
   |long    |short|multiple|single|
   +========+=====+========+======+
   |debug   |dbqs |dbqs    |logs  |
   +--------+-----+--------+------+
   |info    |infs |infs    |logs  |
   +--------+-----+--------+------+
   |warning |wrns |wrns    |logs  |
   +--------+-----+--------+------+
   |error   |errs |errs    |logs  |
   +--------+-----+--------+------+
   |critical|crts |crts    |logs  |
   +--------+-----+--------+------+

Log files naming
^^^^^^^^^^^^^^^^

Conventions
"""""""""""

  .. Naming-conventions-for-logging-file-paths-label:
  .. table:: *Naming conventions for logging file paths*

   +--------+-------------------------------------------------------+-------------------------+
   |Type    |Directory                                              |File                     |
   +========+=======================================================+=========================+
   |debug   |/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>|<Log type>_<ts>_<pid>.log|
   +--------+-------------------------------------------------------+-------------------------+
   |info    |/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>|<Log type>_<ts>_<pid>.log|
   +--------+-------------------------------------------------------+-------------------------+
   |warning |/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>|<Log type>_<ts>_<pid>.log|
   +--------+-------------------------------------------------------+-------------------------+
   |error   |/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>|<Log type>_<ts>_<pid>.log|
   +--------+-------------------------------------------------------+-------------------------+
   |critical|/<dir_dat>/<tenant>/RUN/<package>/<cmd>/<Log directory>|<Log type>_<ts>_<pid>.log|
   +--------+-------------------------------------------------------+-------------------------+

Examples
""""""""

  .. Naming-examples-for-logging-file-paths-label:
  .. table:: *Naming examples for logging file paths*

   +--------+--------------------------------------------+------------------------+
   |Type    |Directory                                   |File                    |
   +========+============================================+========================+
   |debug   |/data/otev/umh/RUN/otev_xls_srr/evupreg/logs|debs_1737118199_9470.log|
   +--------+--------------------------------------------+------------------------+
   |info    |/data/otev/umh/RUN/otev_xls_srr/evupreg/logs|infs_1737118199_9470.log|
   +--------+--------------------------------------------+------------------------+
   |warning |/data/otev/umh/RUN/otev_xls_srr/evupreg/logs|wrns_1737118199_9470.log|
   +--------+--------------------------------------------+------------------------+
   |error   |/data/otev/umh/RUN/otev_xls_srr/evupreg/logs|errs_1737118199_9470.log|
   +--------+--------------------------------------------+------------------------+
   |critical|/data/otev/umh/RUN/otev_xls_srr/evupreg/logs|crts_1737118199_9470.log|
   +--------+--------------------------------------------+------------------------+

Python Terminology
==================

Python package
--------------

Overview
^^^^^^^^

  .. Python package-label:
  .. table:: *Python package*

   +--------------+-----------------------------------------------------------------+
   |Name          |Definition                                                       |
   +==============+==========+======================================================+
   |Python package|Python packages are directories that contains the special module |
   |              |``__init__.py`` and other modules, packages files or directories.|
   +--------------+-----------------------------------------------------------------+
   |Python        |Python sub-packages are python packages which are contained in   |
   |sub-package   |another pyhon package.                                           |
   +--------------+-----------------------------------------------------------------+

Python package sub-directories
------------------------------

Overview
^^^^^^^^

  .. Python package sub-direcories-label:
  .. table:: *Python package sub-directories*

   +--------------+-----------------------------------------+
   |Name          |Definition                               |
   +==============+==========+==============================+
   |Python package|Python packages sub-directories are      |
   |sub-directory |directories contained in python packages.|
   +--------------+-----------------------------------------+
   |Special Python|Special Python package sub-directories   |
   |package       |are python package sub-directories with  |
   |sub-directory |with a special meaning                   |
   +--------------+-----------------------------------------+

Special python package sub-directories
--------------------------------------

Overview
^^^^^^^^

  .. Special-python-package-sub-directories-label:
  .. table:: *Special python sun-directories*

   +----+------------------------------------------+
   |Name|Description                               |
   +====+==========================================+
   |data|Directory for package data files.         |
   +----+------------------------------------------+
   |cfg |Directory for package configuration files.|
   +----+------------------------------------------+

Python package files
--------------------

Overview
^^^^^^^^

  .. Python-package-files-label:
  .. table:: *Python package files*

   +--------------+--------------------------------------------------------------------+
   |Name          |Definition                                                          |
   +==============+==========+=========================================================+
   |Python        |Python packages are files within a python package.                  |
   |package files |                                                                    |
   +--------------+--------------------------------------------------------------------+
   |Special python|Special python package files are package files which are not modules|
   |package files |and used as python marker files like ``__init__.py``                |
   +--------------+--------------------------------------------------------------------+
   |Python package|Python modules are files with suffix ``.py``; they could be empty or|
   |module        |contain python code; other modules can be imported into a module.   |
   +--------------+--------------------------------------------------------------------+
   |Special python|Special python modules like ``__init__.py`` or ``main.py`` are      |
   |package module|python modules with special names and functionality.                |
   +--------------+--------------------------------------------------------------------+

Special python package files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Overview
°°°°°°°°

  .. Special-python-package-files-label:
  .. table:: *Special python package files*

   +--------+--------+---------------------------------------------------------------+
   |Name    |Type    |Description                                                    |
   +========+========+===============================================================+
   |py.typed|Type    |The ``py.typed`` file is a marker file used in Python packages |
   |        |checking|to indicate that the package supports type checking. This is a |
   |        |marker  |part of the PEP 561 standard, which provides a standardized way|
   |        |file    |to package and distribute type information in Python.          |
   +--------+--------+---------------------------------------------------------------+

Special python package modules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Overview
°°°°°°°°

  .. Special-Python-package-modules-label:
  .. table:: *Special Python package modules*

   +--------------+-----------+-----------------------------------------------------------------+
   |Name          |Type       |Description                                                      |
   +==============+===========+=================================================================+
   |__init__.py   |Package    |The dunder (double underscore) module ``__init__.py`` is used to |
   |              |directory  |execute initialisation code or mark the directory it contains as |
   |              |marker     |a package. The Module enforces explicit imports and thus clear   |
   |              |file       |namespace use and call them with the dot notation.               |
   +--------------+-----------+-----------------------------------------------------------------+
   |__main__.py   |entry point|The dunder module ``__main__.py`` serves as an entry point for   |
   |              |for the    |the package. The module is executed when the package is called by|
   |              |package    |the interpreter with the command **python -m <package name>**.   |
   +--------------+-----------+-----------------------------------------------------------------+
   |__version__.py|Version    |The dunder module ``__version__.py`` consist of assignment       |
   |              |file       |statements used in Versioning.                                   |
   +--------------+-----------+-----------------------------------------------------------------+

Python elements
---------------

Overview
°°°°°°°°

  .. Python elements-label:
  .. table:: *Python elements*

   +-------------+--------------------------------------------------------------+
   |Python method|Python methods are python functions defined in python modules.|
   +-------------+--------------------------------------------------------------+
   |Special      |Special python methods are python functions with special names|
   |python method|and functionalities.                                          |
   +-------------+--------------------------------------------------------------+
   |Python class |Python classes are defined in python modules.                 |
   +-------------+--------------------------------------------------------------+
   |Python class |Python class methods are python methods defined python        |
   |method       |classes.                                                      |
   +-------------+--------------------------------------------------------------+

Special python methods
^^^^^^^^^^^^^^^^^^^^^^

Overview
°°°°°°°°

  .. Special-python-methods-label:
  .. table:: *Special python methods*

   +--------+------------+----------------------------------------------------------+
   |Name    |Type        |Description                                               |
   +========+============+==========================================================+
   |__init__|class object|The special method ``__init__`` is called when an instance|
   |        |constructor |(object) of a class is created; instance attributes can be|
   |        |method      |defined and initalized in the method.                     |
   +--------+------------+----------------------------------------------------------+

Table of Contents
=================

.. contents:: **Table of Content**
