ka-utg 2023.2.3
General Utilities
Requires Python: >=3.10

######
ka_utg
######

Overview
========

.. start short_desc

**General 'Utilities'**

.. end short_desc

Installation
============

.. start installation

``ka_utg`` can be installed from PyPI or Anaconda.

To install with ``pip``:

.. code-block:: shell

	$ python -m pip install ka_utg

To install with ``conda``:

.. code-block:: shell

	$ conda install -c conda-forge ka_utg

.. end installation

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

.. code-block:: shell

	$ python -m pip install ka_utg[readme]

Modules
=======
``ka_utg`` contains the following modules.

.. table:: **ka_utg Modules for Array Management**

    +-----------++-----------------------------------------------------+
    | *Module*: || Description                                         |
    +===========++=====================================================+
    | aoa.py    || Array of Arrays                                     |
    +-----------++-----------------------------------------------------+
    | aod.py    || Array of Dictionaries                               |
    +-----------++-----------------------------------------------------+
    | aoo.py    || Arry of Objects                                     |
    +-----------++-----------------------------------------------------+
    | aos.py    || Array of Strings                                    |
    +-----------++-----------------------------------------------------+
    | arr.py    || Array                                               |
    +-----------++-----------------------------------------------------+

.. table:: **ka_utg Modules for Dictionary Management**

    +-----------++-----------------------------------------------------+
    | *Module*: || Description                                         |
    +===========++=====================================================+
    | d2v.py    || Dictionary with 2-dimensional arrays as keys        |
    +-----------++-----------------------------------------------------+
    | d3v.py    || Dictionary with 3-dimensional arrays as key s       |
    +-----------++-----------------------------------------------------+
    | dic.py    || Dictionary                                          |
    +-----------++-----------------------------------------------------+
    | doa.py    || Dictionary of Arrays                                |
    +-----------++-----------------------------------------------------+
    | dod.py    || Dictionary of Dictionaries                          |
    +-----------++-----------------------------------------------------+
    | doo.py    || Dictionary of Objects                               |
    +-----------++-----------------------------------------------------+
    | range.py  || Range Dictionary Management                         |
    +-----------++-----------------------------------------------------+

.. table:: **ka_utg Modules for Object Management**

    +-----------++-----------------------------------------------------+
    | *Module*: || Description                                         |
    +===========++=====================================================+
    | obj.py    || Object Utilities                                    |
    +-----------++-----------------------------------------------------+
    | fnc.py    || Function Utilities                                  |
    +-----------++-----------------------------------------------------+
    | str.py    || String Utilities                                    |
    +-----------++-----------------------------------------------------+

.. table:: **ka_utg Base Modules**

    +-----------++-----------------------------------------------------+
    | *Module*: || Description                                         |
    +===========++=====================================================+
    | col.py    || Colour Handling                                     |
    +-----------++-----------------------------------------------------+
    | log.py    || Log Management                                      |
    +-----------++-----------------------------------------------------+

.. table:: **ka_utg Misc. Modules**

    +-----------++-----------------------------------------------------+
    | *Module*: || Description                                         |
    +===========++=====================================================+
    | args.py   || Arguments Handling                                  |
    +-----------++-----------------------------------------------------+
    | cmd.py    || Utilities for asyncronous or syncronous execution   |
    |           || of commands                                         |
    +-----------++-----------------------------------------------------+
    | cmdline.py|| Command Line Utilities                              |
    +-----------++-----------------------------------------------------+
    | evt.py    || Event Management                                    |
    +-----------++-----------------------------------------------------+
    | exc.py    || Exception Management                                |
    +-----------++-----------------------------------------------------+
    | file.py   || File I/O Utilities                                  |
    +-----------++-----------------------------------------------------+
    | msg.py    || Message Handling                                    |
    +-----------++-----------------------------------------------------+
    | setdic.py || Message Handling                                    |
    +-----------++-----------------------------------------------------+

Appendix
========

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