Metadata-Version: 2.1
Name: ka_uts_dic
Version: 1.0.0.240919
Summary: General Utilities
Author-email: Bernd Stroehle <bernd.stroehle@bs29.com>
Maintainer-email: Bernd Stroehle <bernd.stroehle@bs29.com>
Project-URL: Source Code, https://github.com/bs29/ka_uts_dic/tree/master
Project-URL: Homepage, https://kosakya.de/
Project-URL: Documentation, https://ka-apc.readthedocs.io/en/latest
Project-URL: Apache-2.0 License, https://apache.org/licenses/LICENSE-2.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.12
Classifier: Natural Language :: English
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: ka_uts_arr>=1.0.0.240910
Requires-Dist: ka_uts_df>=1.0.0.240823
Requires-Dist: ka_uts_obj>=1.0.0.240823
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pandas>=2.2.3

##########
ka_uts_dic
##########

Overview
********

.. start short_desc

**Dictionary 'Utilities'**

.. end short_desc

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

.. start installation

Package ``ka_uts_dic`` can be installed from PyPI or Anaconda.

To install with ``pip``:

.. code-block:: shell

	$ python -m pip install ka_uts_dic

To install with ``conda``:

.. code-block:: shell

	$ conda install -c conda-forge ka_uts_dic

.. end installation

This requires that the ``readme`` extra is installed:

.. code-block:: shell

	$ python -m pip install ka_uts_dic[readme]

Configuration
*************

The Configuration of general or tenant specific Package logging is defined in Yaml Configuration Files in the data directory <Package Name>/data of the Package.

  .. logging-configuration-files-label:
  .. table:: *Logging Configuration Files*

   +--------+---------------------------------+-----------------------------------+
   |Logging |Configuration                    |Description                        |
   |Type    +----------------+----------------+-----------------------------------+
   |        |File            |Directory       |                                   |
   +========+================+=========+======+===================================+
   |standard|log.standard.yml|ka_uts_com/data |the Python Logger compatible       |
   |        |                |                |standard Yaml configuraration file |
   |        |                |                |is used to define standard logging |
   +--------+----------------+                +-----------------------------------+
   |personal|log.personal.yml|                |the Python Logger compatible       | 
   |        |                |                |personal Yaml configuration file   |
   |        |                |                |is used to define personal logging |
   +--------+----------------+----------------+-----------------------------------+

Modules
*******

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

The Modules of Package ``ka_uts_dic`` could be classified in the follwing module classes:

#. *Dictionary Management Modules*

Dictionary management Modules
-----------------------------

  .. modules-for-dictionary-magement-label:
  .. table:: *Modules for dictionary management*

   +----------------------------+------------------------------------------------+
   |Module                      |Static Classes                                  |
   +-----------+----------------+-----------+------------------------------------+
   |Name       |Type            |Name       |Description                         |
   +===========+================+===========+====================================+
   |d2v        |Array with      |D2V        |                                    |
   |           |2-dimensinal    |           |                                    |
   |           |array as keys   |           |                                    |
   +-----------+----------------+-----------+------------------------------------+
   |d3v        |Array with      |D3V        |                                    |
   |           |3-dimensinal    |           |                                    |
   |           |array as keys   |           |                                    |
   +-----------+----------------+-----------+------------------------------------+
   |dic        |Dictionary      |Dic        |                                    |
   +-----------+----------------+-----------+------------------------------------+
   |doa        |Dictionary of   |DoA        |                                    |
   |           |Arrays          |           |                                    |
   +-----------+----------------+-----------+------------------------------------+
   |dod        |Dictionary of   |AoD        |                                    |
   |           |Dictionaries    |           |                                    |
   +-----------+----------------+-----------+------------------------------------+
   |doo        |Dictionary of   |DoO        |                                    |
   |           |Objects         |           |                                    |
   +-----------+----------------+-----------+------------------------------------+

Appendix
========

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