Metadata-Version: 2.4
Name: ka_uts_xls
Version: 2.1.0.250408
Summary: Excel Utilities
Author-email: Bernd Stroehle <bernd.stroehle@bs29.com>
Maintainer-email: Bernd Stroehle <bernd.stroehle@bs29.com>
License-Expression: GPL-3.0-only WITH Classpath-exception-2.0 OR BSD-3-Clause
Project-URL: Source Code, https://github.com/bs29/ka_uts_xls/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
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.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>=2.0.1.250407
Requires-Dist: ka_uts_com>=2.0.0.250407
Requires-Dist: ka_uts_dfr>=2.0.0.250402
Requires-Dist: ka_uts_dic>=2.0.0.250402
Requires-Dist: ka_uts_obj>=2.0.0.250404
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pandas>=2.2.3
Requires-Dist: polars>=1.26.0
Requires-Dist: PyExcelerate>=0.12.0
Dynamic: license-file

##########
ka_uts_xls
##########

Overview
********

.. start short_desc

**Excel 'Utilities'**

.. end short_desc

.. start long_desc

**The package ka_uts_xls ís a collection of interface modules to the following 'Python Excel Utilities'**

.. end long_desc

#. *openpyxl*
#. *pyexcelerate*
#. *pandas dataframe excel functions*
#. *polars dataframe excel functions*

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

.. start installation

The package ``ka_uts_xls`` can be installed from PyPI or Anaconda.

To install with ``pip``:

.. code-block:: shell

	$ python -m pip install ka_uts_xls

To install with ``conda``:

.. code-block:: shell

	$ conda install -c conda-forge ka_uts_xls

.. end installation

Package files
*************

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

The Files of Package ``ka_uts_xls`` could be classified into the following file types:

#. *Special files*
#. *Dunder modules*
#. *Package modules*
#. *Data files*

Special files
*************

Special files are used for type checking or other purposes.

  .. Special-file-label:
  .. table:: **Special-file**

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

Dunder Modules
**************

Dunder Modules are Modules whose name contains 2 leading and trailing "_".

Overview
========

  .. Dunder-Modules-label:
  .. table:: *Dunder-Modules*

   +--------------+---------+----------------------------------------------------+
   |Name          |Type     |Description                                         |
   +==============+=========+====================================================+
   |__init__.py   |Package  |Module with no Statements; the module is used to    |
   |              |directory|mark the directory it contains as a package. A dummy| 
   |              |marker   |Module enforces explicit imports and thus clear     |
   |              |file     |namespace use and call them with the dot notation.  |
   +--------------+---------+----------------------------------------------------+
   |__version__.py|Version  |The module consist of Assignment Statements for     |
   |              |file     |system Variables of Versioning                      |
   +--------------+---------+----------------------------------------------------+

__version__.py
==============

Variables
---------

  .. Variables-of-Dunder-module__version__.py-label:
  .. table:: *Variables of Dunder module __version__.py*

   +---------------+-----------------------------------------+
   |Name           |Example                                  |
   +===============+=========================================+
   |__title__      |'ka_uts_xls'                             |
   +---------------+-----------------------------------------+
   |__description__|'Excel 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 2025 bs29'                    |
   +---------------+-----------------------------------------+
   |__cake__       |u'\u2728 \U0001f370 \u2728'              |
   +---------------+-----------------------------------------+

Modules
*******

Overview
========

The Modules of Package ``ka_uts_xls`` could be classified into the 
following module file types:

#. **I/O modules**

   a. *I/O Control module*
   #. *I/O Input modules*
   #. *I/O Output modules*
   #. *I/O Update modules*

#. **Workbook modules**

   a. *Workbook modules using openpyxl*
   #. *Workbook modules using pyexcelerate*

#. **Worksheet modules**

#. **Cell (Row) modules**


I/O Control Module
******************

Overview
========

  .. I/O-Control-Module-label:
  .. table:: *I/O Control Module*

   +------+--------------------------------------+
   |Name  |Description                           |
   +======+======================================+
   |ioc.py|I/O Control processing for excel files|
   +------+--------------------------------------+

ioc.py
======

Static classes
--------------

The I/O Control Module ``ioc.py`` contains the following static classes.

  .. Static-classes-of-I/O-Control-module-ioc.py-label:
  .. table:: *Static Classes of I/O Control Module ioc.py*

   +-------+-----------------------------------------------------------------+
   |Name   |Description                                                      |
   +=======+=================================================================+
   |IocWbOp|Manage I/O control for excel workbooks using openpyxl package    |
   +-------+-----------------------------------------------------------------+
   |IocWbPe|Manage I/O control for excel workbooks using pyexcelerate package|
   +-------+-----------------------------------------------------------------+

IocWbOp
-------

Methods
^^^^^^^

  .. Methods-of-static-class-IocWbOp-label:
  .. table:: *Methods of static class IocWbOp Com*

   +----+----------------------------------------+
   |Name|Description                             |
   +====+========================================+
   |get |get Workbook using the openpyxel package|
   +----+----------------------------------------+

get
^^^

  .. Parameter-of-IocWbOp-method-get-label:
  .. table:: *Parameter of Com method sh_kwargs*

   +---------+-----+--------------------+
   |Name     |Type |Description         |
   +=========+=====+====================+
   |\**kwargs|TyAny|current class       |
   +---------+-----+--------------------+

  .. Return-value-of-IocWPep-method-get-label:
  .. table:: *Return value of IocWbPe method get*

   +----+------+---------------------+
   |Name|Type  |Description          |
   +====+======+=====================+
   |    |TyWbpP|pyexcelerate Workbook|
   +----+------+---------------------+

IocWbPe
-------

Methods
^^^^^^^

  .. Methods-of-static-class-IocWbPe-label:
  .. table:: *Methods of static class IocWbPe Com*

   +----+-------------------------------------------+
   |Name|Description                                |
   +====+===========================================+
   |get |get Workbook using the pyexcelerate package|
   +----+-------------------------------------------+

get
^^^

  .. Parameter-of-static-class-IocWbPe-method-get-label:
  .. table:: *Parameter of.static.class.IocWbPe.method.get*

   +---------+-----+--------------------+
   |Name     |Type |Description         |
   +=========+=====+====================+
   |\**kwargs|TyAny|current class       |
   +---------+-----+--------------------+

  .. Return-value-of-IocWbPe-method-get-label:
  .. table:: *Return value of IocWbPe method get*

   +----+------+---------------------+
   |Name|Type  |Description          |
   +====+======+=====================+
   |    |TyWbPe|pyexcelerate Workbook|
   +----+------+---------------------+

Input I/O Modules
*****************

Overview
========

  .. Input I/O-Modules-label:
  .. table:: *Input I/O Modules*

   +------------+-------------------------------------------------------+
   |Name        |Description                                            |
   +============+=======================================================+
   |ioipath.py  |Run Input I/O for excel workbooks accessed by path     |
   +------------+-------------------------------------------------------+
   |ioipathnm.py|Run Input I/O for excel workbooks accessed by path name|
   +------------+-------------------------------------------------------+

ioipath.py
==========

Static classes
--------------

The Input I/O Module ``ioipath.py`` contains the following static classes.

  .. Static-classes-of-Input-I/O-module-ioipath.py-label:
  .. table:: *Static Classes of Input I/O Module ioipath.py*

   +-----------+----------------------------------------+
   |Name       |Description                             |
   +===========+========================================+
   |IoiPathWbPd|Run Input I/O for excel workbooks       |
   |           |accessed by path using pandas package   |
   +-----------+----------------------------------------+
   |IoiPathWbPl|Run Input I/O for excel workbooks       |
   |           |accessed by path using polaris package  |
   +-----------+----------------------------------------+
   |IoiPathWbOp|Run Input I/O for excel workbooks       |
   |           |accessed by path using openpyxel package|
   +-----------+----------------------------------------+
   |IoiPathWsOp|Run Input I/O for excel worksheets      |
   |           |accessed by path using openpyxel package|
   +-----------+----------------------------------------+

ioipathnm.py
============

Static classes
--------------

The I/O Input Module ``ioipathnm.py`` contains the following static classes.

  .. Static-classes-of-I/O-Input-module-ioipathnm.py-label:
  .. table:: *Static Classes of I/O Input Module ioipathnm.py*

   +-------------+---------------------------------------------+
   |Name         |Description                                  |
   +=============+=============================================+
   |IoiPathnmWbPd|Run Input I/O for excel workbooks            |
   |             |accessed by path name using pandas package   |
   +-------------+---------------------------------------------+
   |IoiPathnmWbPl|Run Input I/O for excel workbooks            |
   |             |accessed by path name using polaris package  |
   +-------------+---------------------------------------------+
   |IoiPathnmWbOp|Run Input I/O for excel workbooks            |
   |             |accessed by path name using openpyxel package|
   +-------------+---------------------------------------------+
   |IoiPathnmWsOp|Run Input I/O for excel worksheets           |
   |             |accessed by path name using openpyxel package|
   +-------------+---------------------------------------------+

Output I/O Modules
******************

Overview
========

  .. Output-I/O-Modules-label:
  .. table:: *Output I/O Modules*

   +----------+-----------------------------------------------------------------+
   |Name      |Description                                                      |
   +==========+=================================================================+
   |ioowbop.py|Run Output I/O for excel workbooks using the openpyxel package   |
   +----------+-----------------------------------------------------------------+
   |ioowbpd.py|Run Output I/O for excel workbooks using the pandas package      |
   +----------+-----------------------------------------------------------------+
   |ioowbpe.py|Run Output I/O for excel workbooks using the pyexcelerate package|
   +----------+-----------------------------------------------------------------+

ioowbop.py
==========

Static classes
--------------

The Output I/O Module ``ioowbop.py`` contains the following static classes.

  .. Static-classes-of-Output-I/O-module-ioowbop.py-label:
  .. table:: *Static Classes of Output I/O Module ioowbop.py*

   +-------------+---------------------------------------------------+
   |Name         |Description                                        |
   +=============+===================================================+
   |IooPathWbOp  |Run Output I/O for excel workbook to file          |
   |             |referenced by path using the openpyxel package     |
   +-------------+---------------------------------------------------+
   |IooPathnmWbOp|Run Output I/O for excel workbook to file          |
   |             |referenced by path name using the openpyxel package|
   +-------------+---------------------------------------------------+

ioowbpd.py
==========

Static classes
--------------

The Output I/O Module ``ioowbpd.py`` contains the following static classes.

  .. Static-classes-of-Output-I/O--module-ioowbpd.py-label:
  .. table:: *Static Classes of Output I/O Module ioowbpd.py*

   +-----------+-------------------------------------------------+
   |Name       |Description                                      |
   +===========+=================================================+
   |IooPathPdDf|Run Output I/O for pandas dataframe to excel file|
   |           |referenced by path using the pandas writer       |
   +-----------+-------------------------------------------------+

ioowbpe.py
==========

Static classes
--------------

The I/O Output Module ``ioowbpe.py`` contains the following static classes.

  .. Static-classes-of-Output-I/O-module-ioowbpe.py-label:
  .. table:: *Static Classes of Output I/O Module ioowbpe.py*

   +-------------+------------------------------------------------------+
   |Name         |Description                                           |
   +=============+======================================================+
   |IooPathWbPe  |Run Output I/O for excel workbook to file             |
   |             |referenced by path using the pyexcelerate package     |
   +-------------+------------------------------------------------------+
   |IooPathnmWbPe|Run Output I/O for excel workbook to file             |
   |             |referenced by path name using the pyexcelerate package|
   +-------------+------------------------------------------------------+

ioupath.py
==========

Static classes
--------------

The I/O Update Module ``ioupath.py`` contains the following static class.

  .. Static-class-of-Update-I/O-module-ioupath.py-label:
  .. table:: *Static Class of Update I/O Module ioupath.py*

   +-----------+---------------------------------------------------+
   |Name       |Description                                        |
   +===========+===================================================+
   |IouPathWbOp|Run Update I/O of Excel template referenced by path|
   |           |by object using the openpyxel package              |
   +-----------+---------------------------------------------------+

Workbook Modules using the package openpyxel 
============================================

Overview
========

  .. Workbook-Module-using-the-package-openpyxel-label:
  .. table:: **Workbook Module using the package openpyxel**

   +-------+-----------------------------------------------------+
   |Name   |Description                                          |
   +=======+=====================================================+
   |wbop.py|Excel Workbook management using the openpyxel package|
   +-------+-----------------------------------------------------+

wbop.py
=======

Classes
-------

The Workbook Module ``wbop.py`` contains the following static class.

  .. Static-class-of-Workbook-module-wbop.py-label:
  .. table:: *Static class of Workbook Module wbop.py*

   +----+-----------------------------------------------------+
   |Name|Description                                          |
   +====+=====================================================+
   |WbOp|Excel Workbook processing using the openpyxel package|
   +----+-----------------------------------------------------+

Workbook Modules using the package pyexcelerate
***********************************************

Overview
========

  .. Workbook-Module-using-the-package-pyexcelerate-label:
  .. table:: **Workbook Module using the package pyexcelerate**

   +-------+--------------------------------------------------------+
   |Name   |Description                                             |
   +=======+========================================================+
   |wbpe.py|Excel Workbook management using the pyexcelerate package|
   +-------+--------------------------------------------------------+

wbpe.py
=======

Classes
-------

The Workbook Module ``wbpe.py`` contains the following static class.

  .. Static-class-of-Workbook-module-wbpe.py-label:
  .. table:: *Static class of Workbook Module wbpe.py*

   +----+--------------------------------------------------------+
   |Name|Description                                             |
   +====+========================================================+
   |WbPe|Excel Workbook processing using the pyexcelerate package|
   +----+--------------------------------------------------------+

Worksheet Modules using the package openpyxel
*********************************************

Overview
========

  .. Worksheet-Module-using-the-package-openpyxel-label:
  .. table:: **Worksheet-Module-using-the-package-openpyxel**

   +-------+-----------------------------------------------------+
   |Name   |Description                                          |
   +=======+=====================================================+
   |wbpe.py|Excel Worksheet management using the openpyxl package|
   +-------+-----------------------------------------------------+

wsop.py
=======

Classes
-------

The Worksheet Module ``wsop.py`` contains the following static class.

  .. Static-class-of-Worksheet-module-wsop.py-label:
  .. table:: *Static class of Worksheet Module wsop.py*

   +----+------------------------------------------------------+
   |Name|Description                                           |
   +====+======================================================+
   |WsOp|Excel Worksheet processing using the openpyxel package|
   +----+------------------------------------------------------+

Cell Modules using the package openpyxel
****************************************

Overview
========

  .. Cell-Module-using-the-package-openpyxel-label:
  .. table:: **Cell-Module-using-the-package-openpyxel**

   +-------+----------------------------------------------------+
   |Name   |Description                                         |
   +=======+====================================================+
   |rwop.py|Excel Cell management using the pyexcelerate package|
   +-------+----------------------------------------------------+

rwop.py
=======

Classes
-------

The Cell Module ``rwop.py`` contains the following static class.

  .. Static-class-of-Cell-module-wsop.py-label:
  .. table:: *Static class of Cell Module wsop.py*

   +----+-------------------------------------------------+
   |Name|Description                                      |
   +====+=================================================+
   |RwOp|Excel Cell processing using the openpyxel package|
   +----+-------------------------------------------------+

Appendix
========

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