<img align="right" src="https://raw.githubusercontent.com/vroncevic/ats_utilities/dev/docs/ats_utilities_logo.png" width="25%">
# ATS Utilities
**ats_utilities** is framework for creating Apps/Tools/Scripts.
Developed in **[python](https://www.python.org/)** 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.
[](https://github.com/vroncevic/ats_utilities/actions/workflows/ats_utilities_python_checker.yml) [](https://github.com/vroncevic/ats_utilities/actions/workflows/ats_utilities_package_checker.yml) [](https://github.com/vroncevic/ats_utilities/issues) [](https://github.com/vroncevic/ats_utilities/graphs/contributors)
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**
- [Installation](#installation)
- [Install using pip](#install-using-pip)
- [Install using build](#install-using-build)
- [Install using py setup](#install-using-py-setup)
- [Install using docker](#install-using-docker)
- [Dependencies](#dependencies)
- [Framework structure](#framework-structure)
- [Docs](#docs)
- [Contributing](#contributing)
- [Copyright and Licence](#copyright-and-licence)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
### Installation
Used next development environment
[](https://github.com/vroncevic/ats_utilities/actions/workflows/ats_utilities_python3_build.yml)
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](https://pypi.org/project/ats-utilities/)**.
You can install by using pip
```bash
# python3
pip3 install ats-utilities
```
##### Install using build
Navigate to **[release page](https://github.com/vroncevic/ats_utilities/releases)** download and extract release archive.
To install **ats-utilities**, run
```bash
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](https://github.com/vroncevic/ats_utilities/releases)** download and extract release archive.
To install **ats-utilities**, locate and run setup.py with arguments
```bash
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](https://pypi.org/project/PyYAML/)
* [bs4 - Screen-scraping library](https://pypi.org/project/beautifulsoup4/)
* [colorama - Cross-platform colored terminal text](https://pypi.org/project/colorama/)
### Framework structure
**ats_utilities** is based on OOP.
Framework structure
```bash
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
[](https://ats-utilities.readthedocs.io/?badge=master)
More documentation and info at
* [ats-utilities.readthedocs.io](https://ats-utilities.readthedocs.io/)
* [www.python.org](https://www.python.org/)
### Contributing
[Contributing to ats_utilities](CONTRIBUTING.md)
### Copyright and Licence
[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)
Copyright (C) 2017 - 2024 by [vroncevic.github.io/ats_utilities](https://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.
[](https://www.python.org/psf/)
[](https://www.python.org/psf/donations/)
Raw data
{
"_id": null,
"home_page": "https://vroncevic.github.io/ats_utilities",
"name": "ats-utilities",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "util,config,log,option,xml,cfg,ini,json,yml,cli,meta",
"author": "Vladimir Roncevic",
"author_email": "elektron.ronca@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ea/fa/b59c76e1b0ca797f430d2dafb9cf48c37db46b62b36877ba24e8f7ea7adf/ats_utilities-3.1.3.tar.gz",
"platform": "any",
"description": "<img align=\"right\" src=\"https://raw.githubusercontent.com/vroncevic/ats_utilities/dev/docs/ats_utilities_logo.png\" width=\"25%\">\n\n# ATS Utilities\n\n**ats_utilities** is framework for creating Apps/Tools/Scripts.\n\nDeveloped in **[python](https://www.python.org/)** code.\n\nThe README is used to introduce the modules and provide instructions on\nhow to install the modules, any machine dependencies it may have and any\nother information that should be provided before the modules are installed.\n\n[](https://github.com/vroncevic/ats_utilities/actions/workflows/ats_utilities_python_checker.yml) [](https://github.com/vroncevic/ats_utilities/actions/workflows/ats_utilities_package_checker.yml) [](https://github.com/vroncevic/ats_utilities/issues) [](https://github.com/vroncevic/ats_utilities/graphs/contributors)\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n**Table of Contents**\n\n- [Installation](#installation)\n - [Install using pip](#install-using-pip)\n - [Install using build](#install-using-build)\n - [Install using py setup](#install-using-py-setup)\n - [Install using docker](#install-using-docker)\n- [Dependencies](#dependencies)\n- [Framework structure](#framework-structure)\n- [Docs](#docs)\n- [Contributing](#contributing)\n- [Copyright and Licence](#copyright-and-licence)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n### Installation\n\nUsed next development environment\n\n\n\n[](https://github.com/vroncevic/ats_utilities/actions/workflows/ats_utilities_python3_build.yml)\n\nCurrently there are four ways to install framework\n* Install process based on using pip mechanism\n* Install process based on build mechanism\n* Install process based on setup.py mechanism\n* Install process based on docker mechanism\n\n##### Install using pip\n\nPython is located at **[pypi.org](https://pypi.org/project/ats-utilities/)**.\n\nYou can install by using pip\n\n```bash\n# python3\npip3 install ats-utilities\n```\n\n##### Install using build\n\nNavigate to **[release page](https://github.com/vroncevic/ats_utilities/releases)** download and extract release archive.\n\nTo install **ats-utilities**, run\n\n```bash\ntar xvzf ats-utilities-x.y.z.tar.gz\ncd ats-utilities-x.y.z\n# python3\nwget https://bootstrap.pypa.io/get-pip.py\npython3 get-pip.py \npython3 -m pip install --upgrade setuptools\npython3 -m pip install --upgrade pip\npython3 -m pip install --upgrade build\npip3 install -r requirements.txt\npython3 -m build --no-isolation --wheel\npip3 install dist/ats-utilities-x.y.z-py3-none-any.whl\nrm -f get-pip.py\n```\n\n##### Install using py setup\n\nNavigate to **[release page](https://github.com/vroncevic/ats_utilities/releases)** download and extract release archive.\n\nTo install **ats-utilities**, locate and run setup.py with arguments\n\n```bash\ntar xvzf ats-utilities-x.y.z.tar.gz\ncd ats-utilities-x.y.z\n# python3\nwget https://bootstrap.pypa.io/get-pip.py\npython3 get-pip.py\npython3 -m pip install --upgrade setuptools\npython3 -m pip install --upgrade pip\npython3 -m pip install --upgrade build\npip3 install -r requirements.txt\npython3 setup.py install_lib\npython3 setup.py install_egg_info\nrm -f get-pip.py\n```\n\n##### Install using docker\n\nYou can use Dockerfile to create image/container.\n\n### Dependencies\n\nThese modules requires other modules and libraries (Python 3.x)\n* [yaml - YAML parser and emitter for Python](https://pypi.org/project/PyYAML/)\n* [bs4 - Screen-scraping library](https://pypi.org/project/beautifulsoup4/)\n* [colorama - Cross-platform colored terminal text](https://pypi.org/project/colorama/)\n\n### Framework structure\n\n**ats_utilities** is based on OOP.\n\nFramework structure\n\n```bash\n ats_utilities/\n \u251c\u2500\u2500 checker/\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 __init__.py\n \u251c\u2500\u2500 cli/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 cfg_cli_meta.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 cfg_cli.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ini_cli_meta.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ini_cli.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 json_cli_meta.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 json_cli.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 xml_cli_meta.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 xml_cli.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 yaml_cli_meta.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 yaml_cli.py\n \u251c\u2500\u2500 config_io/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 abs_read_conf.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 abs_write_conf.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 cfg/\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 cfg2object_meta.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 cfg2object.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 object2cfg_meta.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 object2cfg.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 conf_file_meta.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 file_check.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ini/\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 ini2object_meta.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 ini2object.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 object2ini_meta.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 object2ini.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 json/\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 json2object_meta.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 json2object.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 object2json_meta.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 object2json.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 xml/\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 object2xml_meta.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 object2xml.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 xml2object_meta.py\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 xml2object.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 yaml/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 object2yaml_meta.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 object2yaml.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 yaml2object_meta.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 yaml2object.py\n \u251c\u2500\u2500 console_io/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 error.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 success.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 verbose.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 warning.py\n \u251c\u2500\u2500 exceptions/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_attribute_error.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_bad_call_error.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_file_error.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_key_error.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_lookup_error.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_parameter_error.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_type_error.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_value_error.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 __init__.py\n \u251c\u2500\u2500 info/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_build_date.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_info_meta.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_info_ok.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_licence.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_name.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_version.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 __init__.py\n \u251c\u2500\u2500 __init__.py\n \u251c\u2500\u2500 logging/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_logger_file.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_logger_meta.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_logger_name.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 ats_logger_status.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 __init__.py\n \u251c\u2500\u2500 option/\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 __init__.py\n \u251c\u2500\u2500 pro_config/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 pro_name.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 template_dir.py\n \u2514\u2500\u2500 splash/\n \u251c\u2500\u2500 ext_infrastructure.py\n \u251c\u2500\u2500 github_infrastructure.py\n \u251c\u2500\u2500 __init__.py\n \u251c\u2500\u2500 progress_bar.py\n \u251c\u2500\u2500 splash_meta.py\n \u251c\u2500\u2500 splash_property.py\n \u2514\u2500\u2500 terminal_properties.py\n \n 16 directories, 59 files\n```\n\n### Docs\n\n[](https://ats-utilities.readthedocs.io/?badge=master)\n\nMore documentation and info at\n\n* [ats-utilities.readthedocs.io](https://ats-utilities.readthedocs.io/)\n* [www.python.org](https://www.python.org/)\n\n### Contributing\n\n[Contributing to ats_utilities](CONTRIBUTING.md)\n\n### Copyright and Licence\n\n[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)\n\nCopyright (C) 2017 - 2024 by [vroncevic.github.io/ats_utilities](https://vroncevic.github.io/ats_utilities/)\n\n**ats_utilities** is free software; you can redistribute it and/or modify\nit under the same terms as Python itself, either Python version 3.x or,\nat your option, any later version of Python 3 you may have available.\n\nLets help and support PSF.\n\n[](https://www.python.org/psf/)\n\n[](https://www.python.org/psf/donations/)\n",
"bugtrack_url": null,
"license": "GPL 2017 - 2024 Free software to use and distributed it.",
"summary": "Python App/Tool/Script Utilities",
"version": "3.1.3",
"project_urls": {
"Homepage": "https://vroncevic.github.io/ats_utilities"
},
"split_keywords": [
"util",
"config",
"log",
"option",
"xml",
"cfg",
"ini",
"json",
"yml",
"cli",
"meta"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "178c1276b898da7f8e4a79a10d6d6ea3a59e92366d45fc99d715d63c7113df4e",
"md5": "e0c6d7c11700f9e7e3b9dc8287c876a5",
"sha256": "7af9e7dc9958589b4923eb2182ee09344b59e5d1b3763141d612a5941d016d0f"
},
"downloads": -1,
"filename": "ats_utilities-3.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0c6d7c11700f9e7e3b9dc8287c876a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 108022,
"upload_time": "2023-12-25T16:29:44",
"upload_time_iso_8601": "2023-12-25T16:29:44.756284Z",
"url": "https://files.pythonhosted.org/packages/17/8c/1276b898da7f8e4a79a10d6d6ea3a59e92366d45fc99d715d63c7113df4e/ats_utilities-3.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eafab59c76e1b0ca797f430d2dafb9cf48c37db46b62b36877ba24e8f7ea7adf",
"md5": "d9167ad277ab3d47868515beab0a06a7",
"sha256": "76a585af2b5d4e1339bc55da1eaedc495877bfbe120e80afdf726447367377d6"
},
"downloads": -1,
"filename": "ats_utilities-3.1.3.tar.gz",
"has_sig": false,
"md5_digest": "d9167ad277ab3d47868515beab0a06a7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 40137,
"upload_time": "2023-12-25T16:29:46",
"upload_time_iso_8601": "2023-12-25T16:29:46.851420Z",
"url": "https://files.pythonhosted.org/packages/ea/fa/b59c76e1b0ca797f430d2dafb9cf48c37db46b62b36877ba24e8f7ea7adf/ats_utilities-3.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-25 16:29:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ats-utilities"
}
JSON