ka-ut-com 2023.2.2

Communication Class Utilities

Communication Area

Installation

ka_ut_com can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install ka_ut_com

To install with conda:

$ conda install -c conda-forge ka_ut_com

This requires that the readme extra is installed:

$ python -m pip install ka_ut_com[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.

Configuration Files

Logging Type	Configuration File	Description
general	log.yml	the Python Logger compatible general Configuration file is used to define tenant independend logging
tenant	log.main.tenant.yml	the Python Logger compatible tenant Configuration file is used to define tenant dependend logging

Modules

ka_ut_com contains the following modules.

Base Modules

Base Modules

Module	Description
com.py	The com module contains the the Base Communication class Com and Utility Classes:
	Class	Description
	Com	Base Communication Setup
	Standard	Standard Log Configuration
	Person	Person based Log Configuration
	Cfg	Configuration Management
	Mgo	Mongo Db Configuration Management
	App	Setup Application Management
	Exit	Setup Exit Handling

Utility Modules

Utility Modules

Module	Description
pacmod.py	The pacmod module contains the Pacmod Class with the following Components (Functions and sub classes):
	Component	Type	Description
	sh	function	show pacmod dictionary
	Cfg	class	Configuration Class
	Pmd	class	Package Module Sub Class
	Path	class	Path Management Class
ioc.py	The ioc module contains I/O Classes for the following file types: yaml, json
	Class	Description
	Yaml	I/O for yaml files
	Json	I/O for json files

Special Modules

Special Tehnical Modules

Module	Description
__init__.py	dummy Init Module: contains no Statements
__version__.py	contains Assignment Statements for Version System Variables:
	System Variable	Example
	__title__	‘ka_ut_com’
	__description__	‘Communication Area Utilities.’
	__url__	‘https://ka-com.readthedocs.io/en/latest’
	__version___	‘2023.2.2’
	__build__	0x022200
	__author_email__	‘Bernd Stroehle’
	__license__	‘Apache-2.0’
	__copyright__	‘Copyright 2023 bs29’
	__cake__	u’u2728 U0001f370 u2728’

Appendix

Table of Content

• Installation

• Configuration

• Modules

  • Base Modules

  • Utility Modules

  • Special Modules

• Appendix