ATS UtilitiesΒΆ

☯️ ats_utilities is framework for creating Apps/Tools/Scripts.

Developed in 🐍 python code.

ats_utilities codecov ats_utilities circleci

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.

ats_utilities python checker ats_utilities package checker

ats_utilities github issues ats_utilities github contributors

ats_utilities documentation Status

InstallationΒΆ

Used next development environment

debian linux os

ats_utilities python2 build ats_utilities python3 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
# python2
wget https://bootstrap.pypa.io/pip/2.7/get-pip.py
python2 get-pip.py
python2 -m pip install --upgrade setuptools
python2 -m pip install --upgrade pip
python2 -m pip install --upgrade build
pip2 install -r requirements.txt
python2 -m build --no-isolation --wheel
pip2 install dist/ats_utilities-x.y.z-py2-none-any.whl
rm -f get-pip.py
# 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

Or type the following

tar xvzf ats_utilities-x.y.z.tar.gz
cd ats_utilities-x.y.z/
# python2
wget https://bootstrap.pypa.io/pip/2.7/get-pip.py
python2 get-pip.py
python2 -m pip install --upgrade setuptools
python2 -m pip install --upgrade pip
python2 -m pip install --upgrade build
pip2 install -r requirements.txt
python2 setup.py install_lib
python2 setup.py install_egg_info
# pyton3
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

You can use Docker to create image/container, or You can use pip to install πŸ“¦

# python2
pip2 install ats_utilities
# python3
pip3 install ats_utilities

ats_utilities docker checker

Framework structureΒΆ

ats_utilities is based on OOP.

https://raw.githubusercontent.com/vroncevic/ats_utilities/dev/docs/arch_flow_usage.png

🧰 Framework structure

ats_utilities/
β”œβ”€β”€ abstract/
β”‚Β Β  └── __init__.py
β”œβ”€β”€ checker/
β”‚Β Β  └── __init__.py
β”œβ”€β”€ cli/
β”‚Β Β  β”œβ”€β”€ cfg_cli.py
β”‚Β Β  β”œβ”€β”€ ini_cli.py
β”‚Β Β  β”œβ”€β”€ __init__.py
β”‚Β Β  β”œβ”€β”€ json_cli.py
β”‚Β Β  β”œβ”€β”€ xml_cli.py
β”‚Β Β  └── yaml_cli.py
β”œβ”€β”€ config_io/
β”‚Β Β  β”œβ”€β”€ base_check.py
β”‚Β Β  β”œβ”€β”€ base_read.py
β”‚Β Β  β”œβ”€β”€ base_write.py
β”‚Β Β  β”œβ”€β”€ cfg/
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ cfg2object.py
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
β”‚Β Β  β”‚Β Β  └── object2cfg.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
β”œβ”€β”€ cooperative/
β”‚Β Β  └── __init__.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
β”œβ”€β”€ final/
β”‚Β Β  └── __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/
β”‚Β Β  β”œβ”€β”€ ats_logger_file.py
β”‚Β Β  β”œβ”€β”€ ats_logger_name.py
β”‚Β Β  β”œβ”€β”€ ats_logger_status.py
β”‚Β Β  └── __init__.py
β”œβ”€β”€ option/
β”‚Β Β  └── __init__.py
β”œβ”€β”€ register/
β”‚Β Β  └── __init__.py
β”œβ”€β”€ singleton/
β”‚Β Β  β”œβ”€β”€ base.py
β”‚Β Β  β”œβ”€β”€ functional.py
β”‚Β Β  β”œβ”€β”€ __init__.py
β”‚Β Β  β”œβ”€β”€ meta.py
β”‚Β Β  └── meta_thread.py
└── splash/
    β”œβ”€β”€ ext_infrastructure.py
    β”œβ”€β”€ github_infrastructure.py
    β”œβ”€β”€ __init__.py
    β”œβ”€β”€ progress_bar.py
    β”œβ”€β”€ splash_property.py
    └── terminal_properties.py

Indices and tablesΒΆ