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 designed from the ground up around robust, object-oriented paradigms and industrial-grade design patterns. The codebase strictly adheres to SOLID principles and is partitioned into highly decoupled, modular packages.

Design Pillars

Object-Oriented Architecture (OOP): Employs strong encapsulation, strict interface segregation, and clear class hierarchies to model system components.

SOLID Compliance: Engineered to facilitate seamless framework extension without modification (Open/Closed) and to decouple operations via explicit interface abstractions (Dependency Inversion).

Domain-Driven Package Organization: Functionality is organized into dedicated sub-packages—such as registries, bundle dataclasses, engines, and validators—ensuring clear separation of concerns.

Click to expand framework structure
    ats_utilities/
         ├── base/
            ├── base_bundle.py
            ├── base_registry.py
            ├── engine.py
            ├── ibase.py
            └── __init__.py
         ├── checker/
            ├── checker_bundle.py
            ├── checker_registry.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
               ├── checker_reporter_registry.py
               ├── icheck_reporter.py
               └── __init__.py
            └── type/
                ├── __init__.py
                ├── itype_validator.py
                └── type_validator.py
         ├── config_io/
            ├── conf_file.py
            ├── conf_file_bundle.py
            ├── conf_file_registry.py
            ├── config_io_bundle.py
            ├── config_io_registry.py
            ├── iconf_file.py
            ├── __init__.py
            ├── loader/
               ├── engine.py
               ├── iloader.py
               └── __init__.py
            ├── processor/
               ├── cfg_processor.py
               ├── factory_processor.py
               ├── iconfig_processor.py
               ├── ifactory_processor.py
               ├── ini_processor.py
               ├── __init__.py
               ├── json_processor.py
               ├── xml_processor.py
               └── yaml_processor.py
            └── storer/
                ├── engine.py
                ├── __init__.py
                └── istorer.py
         ├── context/
            ├── context_bundle.py
            ├── context_registry.py
            ├── context_support.py
            ├── icontext_support.py
            └── __init__.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
            ├── format_error.py
            └── __init__.py
         ├── generator/
            ├── engine.py
            ├── gen_params_bundle.py
            ├── gen_params_registry.py
            ├── generator_bundle.py
            ├── generator_registry.py
            ├── igenerator.py
            ├── __init__.py
            ├── scheme/
               ├── engine.py
               ├── __init__.py
               └── ischeme_loader.py
            ├── tar/
               ├── engine.py
               ├── __init__.py
               ├── itar_processor.py
               ├── tar_process_bundle.py
               ├── tar_process_member_bundle.py
               ├── tar_process_member_registry.py
               └── tar_process_registry.py
            └── template/
                ├── engine.py
                ├── __init__.py
                └── itemplate_processor.py
         ├── info/
            ├── build_date/
               ├── engine.py
               ├── ibuild_date.py
               └── __init__.py
            ├── engine.py
            ├── iinfo_manager.py
            ├── info_bundle.py
            ├── info_keys.py
            ├── info_ok/
               ├── engine.py
               ├── iinfo_ok.py
               └── __init__.py
            ├── info_registry.py
            ├── __init__.py
            ├── licence/
               ├── engine.py
               ├── ilicence.py
               └── __init__.py
            ├── log_file/
               ├── engine.py
               ├── ilog_file.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
         ├── logger/
            ├── engine.py
            ├── ilogger.py
            ├── __init__.py
            ├── logger_bundle.py
            └── logger_registry.py
         ├── option/
            ├── command/
               ├── command_option.py
               ├── __init__.py
               └── ioption_command.py
            ├── engine.py
            ├── __init__.py
            ├── ioption_manager.py
            ├── option_bundle.py
            ├── option_namespace.py
            ├── option_registry.py
            ├── parser/
               ├── engine.py
               ├── iarg_parser.py
               ├── __init__.py
               ├── parser_bundle.py
               └── parser_registry.py
            └── strategy/
                ├── engine.py
                ├── __init__.py
                ├── iparser_strategy.py
                ├── parser_strategy_bundle.py
                └── parser_strategy_registry.py
         ├── project_setup/
            ├── __init__.py
            ├── ipro_config.py
            ├── ipro_name.py
            ├── itemplate_dir.py
            ├── pro_config.py
            ├── pro_name.py
            ├── project_setup_bundle.py
            ├── project_setup_registry.py
            └── template_dir.py
         ├── py.typed
         ├── reporter/
            ├── engine.py
            ├── __init__.py
            ├── ireporter.py
            ├── proxy_reporter.py
            ├── reporter_bundle.py
            ├── reporter_registry.py
            └── theme/
                ├── engine.py
                ├── iconsole_theme.py
                └── __init__.py
         ├── splasher/
            ├── 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_bundle.py
            ├── splash_center_bundle.py
            ├── splash_center_registry.py
            ├── splash_keys.py
            ├── splash_registry.py
            └── terminal/
                ├── __init__.py
                ├── iterminal_properties.py
                └── terminal_properties.py
         ├── utils/
            ├── boolean.py
            ├── component.py
            ├── dicts.py
            ├── dirs.py
            ├── files.py
            ├── __init__.py
            ├── iregistry.py
            └── reflection.py
         └── validation/
             ├── check_type.py
             ├── check_value.py
             ├── context_error.py
             └── __init__.py

     43 directories, 198 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/base_bundle.py 49 0 100%
ats_utilities/base/base_registry.py 56 0 100%
ats_utilities/base/engine.py 73 0 100%
ats_utilities/base/ibase.py 17 0 100%
ats_utilities/checker/__init__.py 9 0 100%
ats_utilities/checker/checker_bundle.py 36 0 100%
ats_utilities/checker/checker_registry.py 24 0 100%
ats_utilities/checker/context/__init__.py 9 0 100%
ats_utilities/checker/context/context_provider.py 38 0 100%
ats_utilities/checker/context/icontext_provider.py 11 0 100%
ats_utilities/checker/engine.py 64 0 100%
ats_utilities/checker/format/__init__.py 9 0 100%
ats_utilities/checker/format/format_validator.py 27 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 78 0 100%
ats_utilities/checker/reporter/__init__.py 9 0 100%
ats_utilities/checker/reporter/check_reporter.py 32 0 100%
ats_utilities/checker/reporter/checker_reporter_bundle.py 34 0 100%
ats_utilities/checker/reporter/checker_reporter_registry.py 25 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 43 0 100%
ats_utilities/config_io/__init__.py 9 0 100%
ats_utilities/config_io/conf_file.py 53 0 100%
ats_utilities/config_io/conf_file_bundle.py 30 0 100%
ats_utilities/config_io/conf_file_registry.py 30 0 100%
ats_utilities/config_io/config_io_bundle.py 37 0 100%
ats_utilities/config_io/config_io_registry.py 32 0 100%
ats_utilities/config_io/iconf_file.py 16 0 100%
ats_utilities/config_io/loader/__init__.py 9 0 100%
ats_utilities/config_io/loader/engine.py 51 0 100%
ats_utilities/config_io/loader/iloader.py 14 0 100%
ats_utilities/config_io/processor/__init__.py 9 0 100%
ats_utilities/config_io/processor/cfg_processor.py 56 0 100%
ats_utilities/config_io/processor/factory_processor.py 53 0 100%
ats_utilities/config_io/processor/iconfig_processor.py 13 0 100%
ats_utilities/config_io/processor/ifactory_processor.py 13 0 100%
ats_utilities/config_io/processor/ini_processor.py 94 0 100%
ats_utilities/config_io/processor/json_processor.py 52 0 100%
ats_utilities/config_io/processor/xml_processor.py 94 0 100%
ats_utilities/config_io/processor/yaml_processor.py 52 0 100%
ats_utilities/config_io/storer/__init__.py 9 0 100%
ats_utilities/config_io/storer/engine.py 54 0 100%
ats_utilities/config_io/storer/istorer.py 14 0 100%
ats_utilities/context/__init__.py 9 0 100%
ats_utilities/context/context_bundle.py 35 0 100%
ats_utilities/context/context_registry.py 33 0 100%
ats_utilities/context/context_support.py 45 0 100%
ats_utilities/context/icontext_support.py 14 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/exceptions/format_error.py 22 0 100%
ats_utilities/generator/__init__.py 9 0 100%
ats_utilities/generator/engine.py 73 0 100%
ats_utilities/generator/gen_params_bundle.py 40 0 100%
ats_utilities/generator/gen_params_registry.py 26 0 100%
ats_utilities/generator/generator_bundle.py 36 0 100%
ats_utilities/generator/generator_registry.py 28 0 100%
ats_utilities/generator/igenerator.py 15 0 100%
ats_utilities/generator/scheme/__init__.py 9 0 100%
ats_utilities/generator/scheme/engine.py 49 0 100%
ats_utilities/generator/scheme/ischeme_loader.py 14 0 100%
ats_utilities/generator/tar/__init__.py 9 0 100%
ats_utilities/generator/tar/engine.py 72 0 100%
ats_utilities/generator/tar/itar_processor.py 14 0 100%
ats_utilities/generator/tar/tar_process_bundle.py 39 0 100%
ats_utilities/generator/tar/tar_process_member_bundle.py 34 0 100%
ats_utilities/generator/tar/tar_process_member_registry.py 26 0 100%
ats_utilities/generator/tar/tar_process_registry.py 27 0 100%
ats_utilities/generator/template/__init__.py 9 0 100%
ats_utilities/generator/template/engine.py 35 0 100%
ats_utilities/generator/template/itemplate_processor.py 12 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 39 0 100%
ats_utilities/info/build_date/ibuild_date.py 12 0 100%
ats_utilities/info/engine.py 78 0 100%
ats_utilities/info/iinfo_manager.py 15 0 100%
ats_utilities/info/info_bundle.py 64 0 100%
ats_utilities/info/info_keys.py 30 0 100%
ats_utilities/info/info_ok/__init__.py 9 0 100%
ats_utilities/info/info_ok/engine.py 39 0 100%
ats_utilities/info/info_ok/iinfo_ok.py 12 0 100%
ats_utilities/info/info_registry.py 58 0 100%
ats_utilities/info/licence/__init__.py 9 0 100%
ats_utilities/info/licence/engine.py 39 0 100%
ats_utilities/info/licence/ilicence.py 12 0 100%
ats_utilities/info/log_file/__init__.py 9 0 100%
ats_utilities/info/log_file/engine.py 39 0 100%
ats_utilities/info/log_file/ilog_file.py 12 0 100%
ats_utilities/info/logo/__init__.py 9 0 100%
ats_utilities/info/logo/engine.py 39 0 100%
ats_utilities/info/logo/ilogo.py 12 0 100%
ats_utilities/info/name/__init__.py 9 0 100%
ats_utilities/info/name/engine.py 39 0 100%
ats_utilities/info/name/iname.py 12 0 100%
ats_utilities/info/organization/__init__.py 9 0 100%
ats_utilities/info/organization/engine.py 39 0 100%
ats_utilities/info/organization/iorganization.py 12 0 100%
ats_utilities/info/repository/__init__.py 9 0 100%
ats_utilities/info/repository/engine.py 39 0 100%
ats_utilities/info/repository/irepository.py 12 0 100%
ats_utilities/info/use_github/__init__.py 9 0 100%
ats_utilities/info/use_github/engine.py 39 0 100%
ats_utilities/info/use_github/iuse_github.py 12 0 100%
ats_utilities/info/version/__init__.py 9 0 100%
ats_utilities/info/version/engine.py 39 0 100%
ats_utilities/info/version/iversion.py 12 0 100%
ats_utilities/logger/__init__.py 9 0 100%
ats_utilities/logger/engine.py 141 0 100%
ats_utilities/logger/ilogger.py 12 0 100%
ats_utilities/logger/logger_bundle.py 29 0 100%
ats_utilities/logger/logger_registry.py 31 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 49 0 100%
ats_utilities/option/command/ioption_command.py 13 0 100%
ats_utilities/option/engine.py 72 0 100%
ats_utilities/option/ioption_manager.py 18 0 100%
ats_utilities/option/option_bundle.py 32 0 100%
ats_utilities/option/option_namespace.py 15 0 100%
ats_utilities/option/option_registry.py 31 0 100%
ats_utilities/option/parser/__init__.py 9 0 100%
ats_utilities/option/parser/engine.py 46 0 100%
ats_utilities/option/parser/iarg_parser.py 15 0 100%
ats_utilities/option/parser/parser_bundle.py 33 0 100%
ats_utilities/option/parser/parser_registry.py 25 0 100%
ats_utilities/option/strategy/__init__.py 9 0 100%
ats_utilities/option/strategy/engine.py 92 0 100%
ats_utilities/option/strategy/iparser_strategy.py 17 0 100%
ats_utilities/option/strategy/parser_strategy_bundle.py 33 0 100%
ats_utilities/option/strategy/parser_strategy_registry.py 28 0 100%
ats_utilities/project_setup/__init__.py 9 0 100%
ats_utilities/project_setup/ipro_config.py 14 0 100%
ats_utilities/project_setup/ipro_name.py 12 0 100%
ats_utilities/project_setup/itemplate_dir.py 12 0 100%
ats_utilities/project_setup/pro_config.py 43 0 100%
ats_utilities/project_setup/pro_name.py 39 0 100%
ats_utilities/project_setup/project_setup_bundle.py 35 0 100%
ats_utilities/project_setup/project_setup_registry.py 33 0 100%
ats_utilities/project_setup/template_dir.py 39 0 100%
ats_utilities/reporter/__init__.py 9 0 100%
ats_utilities/reporter/engine.py 68 0 100%
ats_utilities/reporter/ireporter.py 13 0 100%
ats_utilities/reporter/proxy_reporter.py 62 0 100%
ats_utilities/reporter/reporter_bundle.py 32 0 100%
ats_utilities/reporter/reporter_registry.py 28 0 100%
ats_utilities/reporter/theme/__init__.py 9 0 100%
ats_utilities/reporter/theme/engine.py 33 0 100%
ats_utilities/reporter/theme/iconsole_theme.py 11 0 100%
ats_utilities/splasher/__init__.py 9 0 100%
ats_utilities/splasher/engine.py 87 0 100%
ats_utilities/splasher/external/__init__.py 9 0 100%
ats_utilities/splasher/external/ext_infrastructure.py 62 0 100%
ats_utilities/splasher/external/github_infrastructure.py 71 0 100%
ats_utilities/splasher/external/iext_infrastructure.py 14 0 100%
ats_utilities/splasher/isplasher.py 14 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 14 0 100%
ats_utilities/splasher/property/splash_property.py 48 0 100%
ats_utilities/splasher/splash_bundle.py 48 0 100%
ats_utilities/splasher/splash_center_bundle.py 28 0 100%
ats_utilities/splasher/splash_center_registry.py 22 0 100%
ats_utilities/splasher/splash_keys.py 59 0 100%
ats_utilities/splasher/splash_registry.py 47 0 100%
ats_utilities/splasher/terminal/__init__.py 9 0 100%
ats_utilities/splasher/terminal/iterminal_properties.py 13 0 100%
ats_utilities/splasher/terminal/terminal_properties.py 59 0 100%
ats_utilities/utils/__init__.py 9 0 100%
ats_utilities/utils/boolean.py 19 0 100%
ats_utilities/utils/component.py 16 0 100%
ats_utilities/utils/dicts.py 36 0 100%
ats_utilities/utils/dirs.py 19 0 100%
ats_utilities/utils/files.py 123 0 100%
ats_utilities/utils/iregistry.py 12 0 100%
ats_utilities/utils/reflection.py 48 0 100%
ats_utilities/validation/__init__.py 9 0 100%
ats_utilities/validation/check_type.py 37 0 100%
ats_utilities/validation/check_value.py 26 0 100%
ats_utilities/validation/context_error.py 14 0 100%
Total 5596 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.3.tar.gz (114.0 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.3-py3-none-any.whl (319.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ats_utilities-3.4.3.tar.gz
  • Upload date:
  • Size: 114.0 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.3.tar.gz
Algorithm Hash digest
SHA256 55b75f4ee58934c894c122ba8ed1aa5a3bfa42d5e2da3c436b0ee35e657d44ad
MD5 c4da05126082a8048ad215f2a6ad801c
BLAKE2b-256 d7939cb5b4cc52ceca30b33dd89ba0ee31f7e15bfaa335602ed114c8749f67d1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ats_utilities-3.4.3-py3-none-any.whl
  • Upload date:
  • Size: 319.7 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 743376083df4ebb540bad9f01d789248202ce69c1abd0bf3995525fa2c7ca799
MD5 9acf78ced24ef28400ef4343cee17c59
BLAKE2b-256 5e342c7c46dca1c2c26cd6fd0d90d39e728b31357a1016e27cd059f7bc6590b8

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