ats-utilities 3.3.2

Python App/Tool/Script Utilities

ATS Utilities

ats_utilities is framework for creating Apps/Tools/Scripts.

Developed in python code.

The README is used to introduce the modules and provide instructions on how to install the modules, any machine dependencies it may have and any other information that should be provided before the modules are installed.

Table of Contents

• Installation
  • Install using pip
  • Install using build
  • Install using py setup
  • Install using docker
• Dependencies
• Framework structure
• Code coverage
• Docs
• Contributing
• Copyright and Licence

Installation

Used next development environment

Currently there are four ways to install framework

• Install process based on using pip mechanism
• Install process based on build mechanism
• Install process based on setup.py mechanism
• Install process based on docker mechanism

Install using pip

Python is located at pypi.org.

You can install by using pip

# python3
pip3 install ats-utilities

Install using build

Navigate to release page download and extract release archive.

To install ats-utilities, run

tar xvzf ats-utilities-x.y.z.tar.gz
cd ats-utilities-x.y.z
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py 
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 -m build --no-isolation --wheel
pip3 install dist/ats-utilities-x.y.z-py3-none-any.whl
rm -f get-pip.py

Install using py setup

Navigate to release page download and extract release archive.

To install ats-utilities, locate and run setup.py with arguments

tar xvzf ats-utilities-x.y.z.tar.gz
cd ats-utilities-x.y.z
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info
rm -f get-pip.py

Install using docker

You can use Dockerfile to create image/container.

Dependencies

These modules requires other modules and libraries (Python 3.x)

• yaml - YAML parser and emitter for Python
• bs4 - Screen-scraping library
• colorama - Cross-platform colored terminal text
• lxml - XML processing library

Framework structure

ats_utilities is based on OOP.

Framework structure

    ats_utilities/
          ├── checker
          │   └── __init__.py
          ├── cli/
          │   └── __init__.py
          ├── config_io/
          │   ├── cfg/
          │   │   ├── cfg2object.py
          │   │   ├── __init__.py
          │   │   └── object2cfg.py
          │   ├── file_check.py
          │   ├── ini/
          │   │   ├── ini2object.py
          │   │   ├── __init__.py
          │   │   └── object2ini.py
          │   ├── __init__.py
          │   ├── json/
          │   │   ├── __init__.py
          │   │   ├── json2object.py
          │   │   └── object2json.py
          │   ├── xml/
          │   │   ├── __init__.py
          │   │   ├── object2xml.py
          │   │   └── xml2object.py
          │   └── yaml/
          │       ├── __init__.py
          │       ├── object2yaml.py
          │       └── yaml2object.py
          ├── console_io/
          │   ├── error.py
          │   ├── __init__.py
          │   ├── success.py
          │   ├── verbose.py
          │   └── warning.py
          ├── exceptions/
          │   ├── ats_attribute_error.py
          │   ├── ats_bad_call_error.py
          │   ├── ats_file_error.py
          │   ├── ats_key_error.py
          │   ├── ats_lookup_error.py
          │   ├── ats_parameter_error.py
          │   ├── ats_type_error.py
          │   ├── ats_value_error.py
          │   └── __init__.py
          ├── info/
          │   ├── ats_build_date.py
          │   ├── ats_info_ok.py
          │   ├── ats_licence.py
          │   ├── ats_name.py
          │   ├── ats_version.py
          │   └── __init__.py
          ├── __init__.py
          ├── logging/
          │   └── __init__.py
          ├── option/
          │   └── __init__.py
          ├── pro_config/
          │   ├── __init__.py
          │   ├── pro_name.py
          │   └── template_dir.py
          ├── py.typed
          └── splash/
              ├── ext_infrastructure.py
              ├── github_infrastructure.py
              ├── __init__.py
              ├── progress_bar.py
              ├── splash_property.py
              └── terminal_properties.py

    16 directories, 52 files

Code coverage

Name	Stmts	Miss	Cover
ats_utilities/__init__.py	0	0	100%
ats_utilities/checker/__init__.py	73	23	68%
ats_utilities/cli/__init__.py	62	16	74%
ats_utilities/config_io/__init__.py	58	2	97%
ats_utilities/config_io/cfg/__init__.py	46	3	93%
ats_utilities/config_io/cfg/cfg2object.py	46	3	93%
ats_utilities/config_io/cfg/object2cfg.py	48	3	94%
ats_utilities/config_io/file_check.py	79	2	97%
ats_utilities/config_io/ini/__init__.py	52	3	94%
ats_utilities/config_io/ini/ini2object.py	41	3	93%
ats_utilities/config_io/ini/object2ini.py	51	4	92%
ats_utilities/config_io/json/__init__.py	46	3	93%
ats_utilities/config_io/json/json2object.py	40	3	92%
ats_utilities/config_io/json/object2json.py	48	3	94%
ats_utilities/config_io/xml/__init__.py	59	3	95%
ats_utilities/config_io/xml/object2xml.py	51	4	92%
ats_utilities/config_io/xml/xml2object.py	42	3	93%
ats_utilities/config_io/yaml/__init__.py	46	3	93%
ats_utilities/config_io/yaml/object2yaml.py	48	3	94%
ats_utilities/config_io/yaml/yaml2object.py	40	3	92%
ats_utilities/console_io/__init__.py	0	0	100%
ats_utilities/console_io/error.py	40	24	40%
ats_utilities/console_io/success.py	40	24	40%
ats_utilities/console_io/verbose.py	41	24	41%
ats_utilities/console_io/warning.py	40	2	95%
ats_utilities/exceptions/__init__.py	10	10	0%
ats_utilities/exceptions/ats_attribute_error.py	10	0	100%
ats_utilities/exceptions/ats_bad_call_error.py	10	0	100%
ats_utilities/exceptions/ats_file_error.py	10	10	0%
ats_utilities/exceptions/ats_key_error.py	10	0	100%
ats_utilities/exceptions/ats_lookup_error.py	10	0	100%
ats_utilities/exceptions/ats_parameter_error.py	10	0	100%
ats_utilities/exceptions/ats_type_error.py	10	10	0%
ats_utilities/exceptions/ats_value_error.py	10	0	100%
ats_utilities/info/__init__.py	62	2	97%
ats_utilities/info/ats_build_date.py	35	2	94%
ats_utilities/info/ats_info_ok.py	33	2	94%
ats_utilities/info/ats_licence.py	35	2	94%
ats_utilities/info/ats_name.py	35	2	94%
ats_utilities/info/ats_version.py	35	2	94%
ats_utilities/logging/__init__.py	72	8	89%
ats_utilities/option/__init__.py	40	27	32%
ats_utilities/pro_config/__init__.py	37	2	95%
ats_utilities/pro_config/pro_name.py	34	2	94%
ats_utilities/pro_config/template_dir.py	34	2	94%
ats_utilities/splash/__init__.py	63	2	97%
ats_utilities/splash/ext_infrastructure.py	39	3	92%
ats_utilities/splash/github_infrastructure.py	46	3	93%
ats_utilities/splash/progress_bar.py	44	2	95%
ats_utilities/splash/splash_property.py	39	3	92%
ats_utilities/splash/terminal_properties.py	51	3	94%
Total	1961	263	87%

Docs

More documentation and info at

• ats-utilities.readthedocs.io
• www.python.org

Contributing

Contributing to ats_utilities

Copyright and Licence

Copyright (C) 2017 - 2024 by vroncevic.github.io/ats_utilities

ats_utilities is free software; you can redistribute it and/or modify it under the same terms as Python itself, either Python version 3.x or, at your option, any later version of Python 3 you may have available.

Lets help and support PSF.