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
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
Framework structure
ats_utilities is based on OOP.
Framework structure
ats_utilities/
├── checker/
│ └── __init__.py
├── cli/
│ ├── cfg_cli_meta.py
│ ├── cfg_cli.py
│ ├── ini_cli_meta.py
│ ├── ini_cli.py
│ ├── __init__.py
│ ├── json_cli_meta.py
│ ├── json_cli.py
│ ├── xml_cli_meta.py
│ ├── xml_cli.py
│ ├── yaml_cli_meta.py
│ └── yaml_cli.py
├── config_io/
│ ├── abs_read_conf.py
│ ├── abs_write_conf.py
│ ├── cfg/
│ │ ├── cfg2object_meta.py
│ │ ├── cfg2object.py
│ │ ├── __init__.py
│ │ ├── object2cfg_meta.py
│ │ └── object2cfg.py
│ ├── conf_file_meta.py
│ ├── file_check.py
│ ├── ini/
│ │ ├── ini2object_meta.py
│ │ ├── ini2object.py
│ │ ├── __init__.py
│ │ ├── object2ini_meta.py
│ │ └── object2ini.py
│ ├── __init__.py
│ ├── json/
│ │ ├── __init__.py
│ │ ├── json2object_meta.py
│ │ ├── json2object.py
│ │ ├── object2json_meta.py
│ │ └── object2json.py
│ ├── xml/
│ │ ├── __init__.py
│ │ ├── object2xml_meta.py
│ │ ├── object2xml.py
│ │ ├── xml2object_meta.py
│ │ └── xml2object.py
│ └── yaml/
│ ├── __init__.py
│ ├── object2yaml_meta.py
│ ├── object2yaml.py
│ ├── yaml2object_meta.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_meta.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_meta.py
│ ├── ats_logger_name.py
│ ├── ats_logger_status.py
│ └── __init__.py
├── option/
│ └── __init__.py
├── pro_config/
│ ├── __init__.py
│ ├── pro_name.py
│ └── template_dir.py
└── splash/
├── ext_infrastructure.py
├── github_infrastructure.py
├── __init__.py
├── progress_bar.py
├── splash_meta.py
├── splash_property.py
└── terminal_properties.py
16 directories, 59 files
Docs
More documentation and info at
Contributing
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.
