Skip to main content

Python App/Tool/Script Utilities

Project description

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.

ats_utilities_python_checker ats_utilities_package_checker GitHub issues open GitHub contributors

Table of Contents

Installation

Used next development environment

debian linux os

ats_utilities_python3_build ats_utilities_interface_checker ats_utilities_isp_checker ats_utilities_ocp_checker ats_utilities_srp_checker ats_utilities_toc

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)

Framework structure

ats_utilities is based on OOP and following SOLID principles and it is organized in packages.

Click to expand framework structure
    ats_utilities/
         ├── base/
            ├── component_bundle.py
            ├── engine.py
            ├── ibase.py
            └── __init__.py
         ├── checker/
            ├── component_bundle.py
            ├── context/
               ├── context_provider.py
               ├── icontext_provider.py
               └── __init__.py
            ├── engine.py
            ├── format/
               ├── format_validator.py
               ├── iformat_validator.py
               └── __init__.py
            ├── ichecker.py
            ├── __init__.py
            ├── proxy_validator.py
            ├── reporter/
               ├── check_reporter.py
               ├── checker_reporter_bundle.py
               ├── icheck_reporter.py
               └── __init__.py
            └── type/
                ├── __init__.py
                ├── itype_validator.py
                └── type_validator.py
         ├── config_io/
            ├── cfg/
               ├── cfg2object.py
               ├── cfg_loader.py
               ├── cfg_processor.py
               ├── cfg_storer.py
               ├── icfg_processor.py
               ├── __init__.py
               └── object2cfg.py
            ├── conf_file.py
            ├── config_file_bundle.py
            ├── config_loader.py
            ├── config_loader_bundle.py
            ├── file_bundle.py
            ├── file_check.py
            ├── iconf_file.py
            ├── iconfig_loader.py
            ├── ifile_check.py
            ├── iloader.py
            ├── ini/
               ├── iini_processor.py
               ├── ini2object.py
               ├── ini_loader.py
               ├── ini_processor.py
               ├── ini_storer.py
               ├── __init__.py
               └── object2ini.py
            ├── __init__.py
            ├── iread.py
            ├── istorer.py
            ├── iwrite.py
            ├── json/
               ├── ijson_processor.py
               ├── __init__.py
               ├── json2object.py
               ├── json_loader.py
               ├── json_processor.py
               ├── json_storer.py
               └── object2json.py
            ├── xml/
               ├── __init__.py
               ├── ixml_processor.py
               ├── object2xml.py
               ├── xml2object.py
               ├── xml_loader.py
               ├── xml_processor.py
               └── xml_storer.py
            └── yaml/
                ├── __init__.py
                ├── iyaml_processor.py
                ├── object2yaml.py
                ├── yaml2object.py
                ├── yaml_loader.py
                ├── yaml_processor.py
                └── yaml_storer.py
         ├── config_setup/
            ├── component_bundle.py
            ├── __init__.py
            ├── ipro_config.py
            ├── ipro_name.py
            ├── itemplate_dir.py
            ├── pro_config.py
            ├── pro_name.py
            └── template_dir.py
         ├── context_bundle.py
         ├── exceptions/
            ├── ats_attribute_error.py
            ├── ats_bad_call_error.py
            ├── ats_error.py
            ├── ats_file_error.py
            ├── ats_generator_error.py
            ├── ats_key_error.py
            ├── ats_lookup_error.py
            ├── ats_parameter_error.py
            ├── ats_runtime_error.py
            ├── ats_type_error.py
            ├── ats_value_error.py
            └── __init__.py
         ├── factory_class.py
         ├── factory_component.py
         ├── factory_context_bundle.py
         ├── factory_context_error.py
         ├── factory_dict_utils.py
         ├── factory_file_utils.py
         ├── factory_inspector.py
         ├── factory_type.py
         ├── factory_value.py
         ├── generator/
            ├── component_bundle.py
            ├── engine.py
            ├── generator_bundle.py
            ├── igenerator.py
            ├── __init__.py
            ├── scheme/
               ├── __init__.py
               ├── ischeme_loader.py
               └── scheme_loader.py
            ├── tar/
               ├── __init__.py
               ├── itar_processor.py
               ├── tar_process_bundle.py
               ├── tar_process_member_bundle.py
               └── tar_processor.py
            └── template/
                ├── __init__.py
                ├── itemplate_processor.py
                └── template_processor.py
         ├── info/
            ├── build_date/
               ├── engine.py
               ├── ibuild_date.py
               └── __init__.py
            ├── component_bundle.py
            ├── engine.py
            ├── imanager.py
            ├── info_keys.py
            ├── info_ok/
               ├── engine.py
               ├── iinfo_ok.py
               └── __init__.py
            ├── __init__.py
            ├── licence/
               ├── engine.py
               ├── ilicence.py
               └── __init__.py
            ├── logo/
               ├── engine.py
               ├── ilogo.py
               └── __init__.py
            ├── name/
               ├── engine.py
               ├── iname.py
               └── __init__.py
            ├── organization/
               ├── engine.py
               ├── __init__.py
               └── iorganization.py
            ├── repository/
               ├── engine.py
               ├── __init__.py
               └── irepository.py
            ├── use_github/
               ├── engine.py
               ├── __init__.py
               └── iuse_github.py
            └── version/
                ├── engine.py
                ├── __init__.py
                └── iversion.py
         ├── __init__.py
         ├── logging/
            ├── component_bundle.py
            ├── engine.py
            ├── ilogger_manager.py
            ├── __init__.py
            └── logger/
                ├── ilogger.py
                ├── __init__.py
                ├── logger.py
                └── logger_bundle.py
         ├── option/
            ├── command/
               ├── command_option.py
               ├── __init__.py
               └── ioption_command.py
            ├── component_bundle.py
            ├── engine.py
            ├── __init__.py
            ├── ioption_manager.py
            ├── option_namespace.py
            ├── parser/
               ├── engine.py
               └── __init__.py
            └── strategy/
                ├── __init__.py
                ├── iparser_strategy.py
                └── parser_strategy.py
         ├── py.typed
         ├── reporter/
            ├── component_bundle.py
            ├── engine.py
            ├── __init__.py
            ├── ireporter.py
            ├── proxy_reporter.py
            └── theme/
                ├── engine.py
                ├── iconsole_theme.py
                └── __init__.py
         └── splasher/
             ├── component_bundle.py
             ├── engine.py
             ├── external/
                ├── ext_infrastructure.py
                ├── github_infrastructure.py
                ├── iext_infrastructure.py
                └── __init__.py
             ├── __init__.py
             ├── isplasher.py
             ├── progressbar/
                ├── __init__.py
                ├── iprogress_bar.py
                └── progress_bar.py
             ├── property/
                ├── __init__.py
                ├── isplash_property.py
                └── splash_property.py
             ├── splash_center_bundle.py
             ├── splash_keys.py
             └── terminal/
                 ├── __init__.py
                 ├── iterminal_properties.py
                 └── terminal_properties.py

     42 directories, 199 files

Code coverage

Click to expand code coverage
Name Stmts Miss Cover
ats_utilities/__init__.py 9 0 100%
ats_utilities/base/__init__.py 9 0 100%
ats_utilities/base/component_bundle.py 108 0 100%
ats_utilities/base/engine.py 78 0 100%
ats_utilities/base/ibase.py 16 0 100%
ats_utilities/checker/__init__.py 9 0 100%
ats_utilities/checker/component_bundle.py 59 0 100%
ats_utilities/checker/context/__init__.py 9 0 100%
ats_utilities/checker/context/context_provider.py 36 0 100%
ats_utilities/checker/context/icontext_provider.py 11 0 100%
ats_utilities/checker/engine.py 68 0 100%
ats_utilities/checker/format/__init__.py 9 0 100%
ats_utilities/checker/format/format_validator.py 24 0 100%
ats_utilities/checker/format/iformat_validator.py 11 0 100%
ats_utilities/checker/ichecker.py 20 0 100%
ats_utilities/checker/proxy_validator.py 59 0 100%
ats_utilities/checker/reporter/__init__.py 9 0 100%
ats_utilities/checker/reporter/check_reporter.py 30 0 100%
ats_utilities/checker/reporter/checker_reporter_bundle.py 44 0 100%
ats_utilities/checker/reporter/icheck_reporter.py 12 0 100%
ats_utilities/checker/type/__init__.py 9 0 100%
ats_utilities/checker/type/itype_validator.py 12 0 100%
ats_utilities/checker/type/type_validator.py 33 0 100%
ats_utilities/config_io/__init__.py 9 0 100%
ats_utilities/config_io/cfg/__init__.py 9 0 100%
ats_utilities/config_io/cfg/cfg2object.py 60 0 100%
ats_utilities/config_io/cfg/cfg_loader.py 49 0 100%
ats_utilities/config_io/cfg/cfg_processor.py 36 0 100%
ats_utilities/config_io/cfg/cfg_storer.py 44 0 100%
ats_utilities/config_io/cfg/icfg_processor.py 11 0 100%
ats_utilities/config_io/cfg/object2cfg.py 61 0 100%
ats_utilities/config_io/conf_file.py 69 0 100%
ats_utilities/config_io/config_file_bundle.py 33 0 100%
ats_utilities/config_io/config_loader.py 59 0 100%
ats_utilities/config_io/config_loader_bundle.py 40 0 100%
ats_utilities/config_io/file_bundle.py 34 0 100%
ats_utilities/config_io/file_check.py 69 0 100%
ats_utilities/config_io/iconf_file.py 15 0 100%
ats_utilities/config_io/iconfig_loader.py 23 0 100%
ats_utilities/config_io/ifile_check.py 13 0 100%
ats_utilities/config_io/iloader.py 12 0 100%
ats_utilities/config_io/ini/__init__.py 9 0 100%
ats_utilities/config_io/ini/iini_processor.py 12 0 100%
ats_utilities/config_io/ini/ini2object.py 59 0 100%
ats_utilities/config_io/ini/ini_loader.py 49 0 100%
ats_utilities/config_io/ini/ini_processor.py 44 0 100%
ats_utilities/config_io/ini/ini_storer.py 50 0 100%
ats_utilities/config_io/ini/object2ini.py 60 0 100%
ats_utilities/config_io/iread.py 12 0 100%
ats_utilities/config_io/istorer.py 12 0 100%
ats_utilities/config_io/iwrite.py 12 0 100%
ats_utilities/config_io/json/__init__.py 9 0 100%
ats_utilities/config_io/json/ijson_processor.py 11 0 100%
ats_utilities/config_io/json/json2object.py 60 0 100%
ats_utilities/config_io/json/json_loader.py 49 0 100%
ats_utilities/config_io/json/json_processor.py 33 0 100%
ats_utilities/config_io/json/json_storer.py 49 0 100%
ats_utilities/config_io/json/object2json.py 60 0 100%
ats_utilities/config_io/xml/__init__.py 9 0 100%
ats_utilities/config_io/xml/ixml_processor.py 11 0 100%
ats_utilities/config_io/xml/object2xml.py 63 0 100%
ats_utilities/config_io/xml/xml2object.py 63 0 100%
ats_utilities/config_io/xml/xml_loader.py 49 0 100%
ats_utilities/config_io/xml/xml_processor.py 46 0 100%
ats_utilities/config_io/xml/xml_storer.py 57 0 100%
ats_utilities/config_io/yaml/__init__.py 9 0 100%
ats_utilities/config_io/yaml/iyaml_processor.py 11 0 100%
ats_utilities/config_io/yaml/object2yaml.py 60 0 100%
ats_utilities/config_io/yaml/yaml2object.py 61 0 100%
ats_utilities/config_io/yaml/yaml_loader.py 49 0 100%
ats_utilities/config_io/yaml/yaml_processor.py 34 0 100%
ats_utilities/config_io/yaml/yaml_storer.py 49 0 100%
ats_utilities/config_setup/__init__.py 9 0 100%
ats_utilities/config_setup/component_bundle.py 41 0 100%
ats_utilities/config_setup/ipro_config.py 13 0 100%
ats_utilities/config_setup/ipro_name.py 11 0 100%
ats_utilities/config_setup/itemplate_dir.py 11 0 100%
ats_utilities/config_setup/pro_config.py 48 0 100%
ats_utilities/config_setup/pro_name.py 44 0 100%
ats_utilities/config_setup/template_dir.py 44 0 100%
ats_utilities/context_bundle.py 45 0 100%
ats_utilities/exceptions/__init__.py 21 0 100%
ats_utilities/exceptions/ats_attribute_error.py 11 0 100%
ats_utilities/exceptions/ats_bad_call_error.py 11 0 100%
ats_utilities/exceptions/ats_error.py 10 0 100%
ats_utilities/exceptions/ats_file_error.py 11 0 100%
ats_utilities/exceptions/ats_generator_error.py 11 0 100%
ats_utilities/exceptions/ats_key_error.py 11 0 100%
ats_utilities/exceptions/ats_lookup_error.py 11 0 100%
ats_utilities/exceptions/ats_parameter_error.py 11 0 100%
ats_utilities/exceptions/ats_runtime_error.py 11 0 100%
ats_utilities/exceptions/ats_type_error.py 11 0 100%
ats_utilities/exceptions/ats_value_error.py 11 0 100%
ats_utilities/factory_class.py 71 0 100%
ats_utilities/factory_component.py 16 0 100%
ats_utilities/factory_context_bundle.py 17 0 100%
ats_utilities/factory_context_error.py 16 0 100%
ats_utilities/factory_dict_utils.py 26 0 100%
ats_utilities/factory_file_utils.py 116 0 100%
ats_utilities/factory_inspector.py 25 0 100%
ats_utilities/factory_type.py 37 0 100%
ats_utilities/factory_value.py 21 0 100%
ats_utilities/generator/__init__.py 9 0 100%
ats_utilities/generator/component_bundle.py 54 0 100%
ats_utilities/generator/engine.py 84 0 100%
ats_utilities/generator/generator_bundle.py 41 0 100%
ats_utilities/generator/igenerator.py 14 0 100%
ats_utilities/generator/scheme/__init__.py 9 0 100%
ats_utilities/generator/scheme/ischeme_loader.py 13 0 100%
ats_utilities/generator/scheme/scheme_loader.py 51 0 100%
ats_utilities/generator/tar/__init__.py 9 0 100%
ats_utilities/generator/tar/itar_processor.py 13 0 100%
ats_utilities/generator/tar/tar_process_bundle.py 44 0 100%
ats_utilities/generator/tar/tar_process_member_bundle.py 39 0 100%
ats_utilities/generator/tar/tar_processor.py 71 0 100%
ats_utilities/generator/template/__init__.py 9 0 100%
ats_utilities/generator/template/itemplate_processor.py 11 0 100%
ats_utilities/generator/template/template_processor.py 40 0 100%
ats_utilities/info/__init__.py 9 0 100%
ats_utilities/info/build_date/__init__.py 9 0 100%
ats_utilities/info/build_date/engine.py 44 0 100%
ats_utilities/info/build_date/ibuild_date.py 11 0 100%
ats_utilities/info/component_bundle.py 103 0 100%
ats_utilities/info/engine.py 82 0 100%
ats_utilities/info/imanager.py 14 0 100%
ats_utilities/info/info_keys.py 28 0 100%
ats_utilities/info/info_ok/__init__.py 9 0 100%
ats_utilities/info/info_ok/engine.py 44 0 100%
ats_utilities/info/info_ok/iinfo_ok.py 11 0 100%
ats_utilities/info/licence/__init__.py 9 0 100%
ats_utilities/info/licence/engine.py 44 0 100%
ats_utilities/info/licence/ilicence.py 11 0 100%
ats_utilities/info/logo/__init__.py 9 0 100%
ats_utilities/info/logo/engine.py 44 0 100%
ats_utilities/info/logo/ilogo.py 11 0 100%
ats_utilities/info/name/__init__.py 9 0 100%
ats_utilities/info/name/engine.py 44 0 100%
ats_utilities/info/name/iname.py 11 0 100%
ats_utilities/info/organization/__init__.py 9 0 100%
ats_utilities/info/organization/engine.py 44 0 100%
ats_utilities/info/organization/iorganization.py 11 0 100%
ats_utilities/info/repository/__init__.py 9 0 100%
ats_utilities/info/repository/engine.py 44 0 100%
ats_utilities/info/repository/irepository.py 11 0 100%
ats_utilities/info/use_github/__init__.py 9 0 100%
ats_utilities/info/use_github/engine.py 44 0 100%
ats_utilities/info/use_github/iuse_github.py 11 0 100%
ats_utilities/info/version/__init__.py 9 0 100%
ats_utilities/info/version/engine.py 44 0 100%
ats_utilities/info/version/iversion.py 11 0 100%
ats_utilities/logging/__init__.py 9 0 100%
ats_utilities/logging/component_bundle.py 46 0 100%
ats_utilities/logging/engine.py 70 0 100%
ats_utilities/logging/ilogger_manager.py 13 0 100%
ats_utilities/logging/logger/__init__.py 9 0 100%
ats_utilities/logging/logger/ilogger.py 24 0 100%
ats_utilities/logging/logger/logger.py 63 0 100%
ats_utilities/logging/logger/logger_bundle.py 37 0 100%
ats_utilities/option/__init__.py 9 0 100%
ats_utilities/option/command/__init__.py 9 0 100%
ats_utilities/option/command/command_option.py 48 0 100%
ats_utilities/option/command/ioption_command.py 13 0 100%
ats_utilities/option/component_bundle.py 44 0 100%
ats_utilities/option/engine.py 84 0 100%
ats_utilities/option/ioption_manager.py 17 0 100%
ats_utilities/option/option_namespace.py 15 0 100%
ats_utilities/option/parser/__init__.py 9 0 100%
ats_utilities/option/parser/engine.py 35 0 100%
ats_utilities/option/strategy/__init__.py 9 0 100%
ats_utilities/option/strategy/iparser_strategy.py 16 0 100%
ats_utilities/option/strategy/parser_strategy.py 92 0 100%
ats_utilities/reporter/__init__.py 9 0 100%
ats_utilities/reporter/component_bundle.py 41 0 100%
ats_utilities/reporter/engine.py 60 0 100%
ats_utilities/reporter/ireporter.py 13 0 100%
ats_utilities/reporter/proxy_reporter.py 57 0 100%
ats_utilities/reporter/theme/__init__.py 9 0 100%
ats_utilities/reporter/theme/engine.py 31 0 100%
ats_utilities/reporter/theme/iconsole_theme.py 11 0 100%
ats_utilities/splasher/__init__.py 9 0 100%
ats_utilities/splasher/component_bundle.py 87 0 100%
ats_utilities/splasher/engine.py 95 0 100%
ats_utilities/splasher/external/__init__.py 9 0 100%
ats_utilities/splasher/external/ext_infrastructure.py 67 0 100%
ats_utilities/splasher/external/github_infrastructure.py 76 0 100%
ats_utilities/splasher/external/iext_infrastructure.py 13 0 100%
ats_utilities/splasher/isplasher.py 13 0 100%
ats_utilities/splasher/progressbar/__init__.py 9 0 100%
ats_utilities/splasher/progressbar/iprogress_bar.py 11 0 100%
ats_utilities/splasher/progressbar/progress_bar.py 60 0 100%
ats_utilities/splasher/property/__init__.py 9 0 100%
ats_utilities/splasher/property/isplash_property.py 13 0 100%
ats_utilities/splasher/property/splash_property.py 53 0 100%
ats_utilities/splasher/splash_center_bundle.py 43 0 100%
ats_utilities/splasher/splash_keys.py 59 0 100%
ats_utilities/splasher/terminal/__init__.py 9 0 100%
ats_utilities/splasher/terminal/iterminal_properties.py 12 0 100%
ats_utilities/splasher/terminal/terminal_properties.py 60 0 100%
Total 6175 0 100%

Docs

Documentation Status

More documentation and info at

Contributing

Contributing to ats_utilities

Copyright and Licence

license: gpl v3 license apache 2.0

Copyright (C) 2017 - 2026 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.

Python Software Foundation

Donate

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ats_utilities-3.4.2.tar.gz (112.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ats_utilities-3.4.2-py3-none-any.whl (328.0 kB view details)

Uploaded Python 3

File details

Details for the file ats_utilities-3.4.2.tar.gz.

File metadata

  • Download URL: ats_utilities-3.4.2.tar.gz
  • Upload date:
  • Size: 112.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.0 CPython/3.12.3

File hashes

Hashes for ats_utilities-3.4.2.tar.gz
Algorithm Hash digest
SHA256 2d5150c6c094abd923b5a1c8947021a5c1a53b3dca66451990e2097d0f1dcae9
MD5 cf53cd098d880b5d81cf9895f8365372
BLAKE2b-256 fd14e2020a6c405184d1c419f5e9715faef5b43ee57ac6e54acd66fc52130471

See more details on using hashes here.

File details

Details for the file ats_utilities-3.4.2-py3-none-any.whl.

File metadata

  • Download URL: ats_utilities-3.4.2-py3-none-any.whl
  • Upload date:
  • Size: 328.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.0 CPython/3.12.3

File hashes

Hashes for ats_utilities-3.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 43108a186b6249b621de02d5d5e05cf635970fddffe8f1c7408e0784f5759412
MD5 625a57e259afda5b9ac341d3cbb0148d
BLAKE2b-256 9afd73c878c61fe4c6c08d5e174f58bab2e4717047471c5a5677d573feb08c8a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page