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

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.

Framework structure

    ats_utilities/
        ├── checker/
           ├── ats_checker.py
           ├── check_reporter.py
           ├── context_provider.py
           ├── format_validator.py
           ├── ichecker.py
           ├── icheck_reporter.py
           ├── icontext_provider.py
           ├── iformat_validator.py
           ├── __init__.py
           ├── itype_validator.py
           └── type_validator.py
        ├── cli/
           ├── ats_cli.py
           ├── config_manager.py
           ├── icli.py
           ├── iconfig_manager.py
           └── __init__.py
        ├── config_io/
           ├── cfg/
              ├── cfg2object.py
              ├── cfgbase.py
              ├── cfg_processor.py
              ├── icfg_processor.py
              ├── __init__.py
              └── object2cfg.py
           ├── conf_file.py
           ├── file_check.py
           ├── iconf_file.py
           ├── ifile_check.py
           ├── ini/
              ├── iini_processor.py
              ├── ini2object.py
              ├── inibase.py
              ├── ini_processor.py
              ├── __init__.py
              └── object2ini.py
           ├── __init__.py
           ├── iread.py
           ├── iwrite.py
           ├── json/
              ├── ijson_processor.py
              ├── __init__.py
              ├── json2object.py
              ├── jsonbase.py
              ├── json_processor.py
              └── object2json.py
           ├── xml/
              ├── __init__.py
              ├── ixml_processor.py
              ├── object2xml.py
              ├── xml2object.py
              ├── xmlbase.py
              └── xml_processor.py
           └── yaml/
               ├── __init__.py
               ├── iyaml_processor.py
               ├── object2yaml.py
               ├── yaml2object.py
               ├── yamlbase.py
               └── yaml_processor.py
        ├── console_io/
           ├── __init__.py
           ├── ireporter.py
           ├── reporter.py
           └── theme/
               ├── default_theme.py
               ├── iconsole_theme.py
               └── __init__.py
        ├── exceptions/
           ├── ats_attribute_error.py
           ├── ats_bad_call_error.py
           ├── ats_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_info.py
           ├── build_date.py
           ├── ibuild_date.py
           ├── iinfo_ok.py
           ├── ilicence.py
           ├── iname.py
           ├── info_ok.py
           ├── __init__.py
           ├── iversion.py
           ├── licence.py
           ├── name.py
           └── version.py
        ├── __init__.py
        ├── logging/
           ├── ats_logger_manager.py
           ├── ilogger.py
           ├── __init__.py
           └── logger.py
        ├── option/
           ├── ats_option_parser.py
           ├── ats_parser_strategy.py
           ├── __init__.py
           ├── ioption_parser.py
           ├── iparser_strategy.py
           └── option_namespace.py
        ├── pro_config/
           ├── __init__.py
           ├── ipro_config.py
           ├── ipro_name.py
           ├── itemplate_dir.py
           ├── pro_config.py
           ├── pro_name.py
           └── template_dir.py
        ├── py.typed
        └── splash/
            ├── ats_splash.py
            ├── ext_infrastructure.py
            ├── github_infrastructure.py
            ├── iext_infrastructure.py
            ├── __init__.py
            ├── iprogress_bar.py
            ├── isplash.py
            ├── isplash_screen.py
            ├── iterminal_properties.py
            ├── progress_bar.py
            ├── splash_property.py
            └── terminal_properties.py

    17 directories, 112 files

Code coverage

Name Stmts Miss Cover
ats_utilities/__init__.py 9 0 100%
ats_utilities/checker/__init__.py 9 0 100%
ats_utilities/checker/ats_checker.py 51 0 100%
ats_utilities/checker/check_reporter.py 21 0 100%
ats_utilities/checker/context_provider.py 16 0 100%
ats_utilities/checker/format_validator.py 17 0 100%
ats_utilities/checker/icheck_reporter.py 15 1 93%
ats_utilities/checker/ichecker.py 26 1 96%
ats_utilities/checker/icontext_provider.py 14 1 93%
ats_utilities/checker/iformat_validator.py 17 2 88%
ats_utilities/checker/itype_validator.py 20 3 85%
ats_utilities/checker/type_validator.py 17 2 88%
ats_utilities/cli/__init__.py 9 0 100%
ats_utilities/cli/ats_cli.py 40 4 90%
ats_utilities/cli/config_manager.py 51 0 100%
ats_utilities/cli/icli.py 25 4 84%
ats_utilities/cli/iconfig_manager.py 20 1 95%
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 46 1 98%
ats_utilities/config_io/cfg/cfg_processor.py 27 1 96%
ats_utilities/config_io/cfg/cfgbase.py 52 0 100%
ats_utilities/config_io/cfg/icfg_processor.py 20 3 85%
ats_utilities/config_io/cfg/object2cfg.py 52 0 100%
ats_utilities/config_io/conf_file.py 63 0 100%
ats_utilities/config_io/file_check.py 69 0 100%
ats_utilities/config_io/iconf_file.py 18 2 89%
ats_utilities/config_io/ifile_check.py 25 4 84%
ats_utilities/config_io/ini/__init__.py 9 0 100%
ats_utilities/config_io/ini/iini_processor.py 20 3 85%
ats_utilities/config_io/ini/ini2object.py 45 1 98%
ats_utilities/config_io/ini/ini_processor.py 30 8 73%
ats_utilities/config_io/ini/inibase.py 54 0 100%
ats_utilities/config_io/ini/object2ini.py 51 0 100%
ats_utilities/config_io/iread.py 14 1 93%
ats_utilities/config_io/iwrite.py 14 1 93%
ats_utilities/config_io/json/__init__.py 9 0 100%
ats_utilities/config_io/json/ijson_processor.py 20 3 85%
ats_utilities/config_io/json/json2object.py 46 1 98%
ats_utilities/config_io/json/json_processor.py 24 3 88%
ats_utilities/config_io/json/jsonbase.py 52 0 100%
ats_utilities/config_io/json/object2json.py 51 0 100%
ats_utilities/config_io/xml/__init__.py 9 0 100%
ats_utilities/config_io/xml/ixml_processor.py 20 3 85%
ats_utilities/config_io/xml/object2xml.py 53 1 98%
ats_utilities/config_io/xml/xml2object.py 47 0 100%
ats_utilities/config_io/xml/xml_processor.py 33 6 82%
ats_utilities/config_io/xml/xmlbase.py 54 0 100%
ats_utilities/config_io/yaml/__init__.py 9 0 100%
ats_utilities/config_io/yaml/iyaml_processor.py 20 3 85%
ats_utilities/config_io/yaml/object2yaml.py 51 0 100%
ats_utilities/config_io/yaml/yaml2object.py 46 1 98%
ats_utilities/config_io/yaml/yaml_processor.py 24 3 88%
ats_utilities/config_io/yaml/yamlbase.py 52 0 100%
ats_utilities/console_io/__init__.py 9 0 100%
ats_utilities/console_io/ireporter.py 25 4 84%
ats_utilities/console_io/reporter.py 35 1 97%
ats_utilities/console_io/theme/__init__.py 9 0 100%
ats_utilities/console_io/theme/default_theme.py 16 0 100%
ats_utilities/console_io/theme/iconsole_theme.py 14 1 93%
ats_utilities/exceptions/__init__.py 9 0 100%
ats_utilities/exceptions/ats_attribute_error.py 10 0 100%
ats_utilities/exceptions/ats_bad_call_error.py 10 0 100%
ats_utilities/exceptions/ats_error.py 10 10 0%
ats_utilities/exceptions/ats_file_error.py 10 0 100%
ats_utilities/exceptions/ats_key_error.py 10 0 100%
ats_utilities/exceptions/ats_lookup_error.py 10 0 100%
ats_utilities/exceptions/ats_parameter_error.py 10 0 100%
ats_utilities/exceptions/ats_type_error.py 10 0 100%
ats_utilities/exceptions/ats_value_error.py 10 0 100%
ats_utilities/info/__init__.py 9 0 100%
ats_utilities/info/ats_info.py 63 0 100%
ats_utilities/info/build_date.py 36 1 97%
ats_utilities/info/ibuild_date.py 22 3 86%
ats_utilities/info/iinfo_ok.py 19 2 89%
ats_utilities/info/ilicence.py 22 3 86%
ats_utilities/info/iname.py 22 3 86%
ats_utilities/info/info_ok.py 34 0 100%
ats_utilities/info/iversion.py 22 3 86%
ats_utilities/info/licence.py 36 1 97%
ats_utilities/info/name.py 36 0 100%
ats_utilities/info/version.py 36 0 100%
ats_utilities/logging/__init__.py 9 0 100%
ats_utilities/logging/ats_logger_manager.py 29 1 97%
ats_utilities/logging/ilogger.py 35 1 97%
ats_utilities/logging/logger.py 63 5 92%
ats_utilities/option/__init__.py 9 0 100%
ats_utilities/option/ats_option_parser.py 46 7 85%
ats_utilities/option/ats_parser_strategy.py 43 8 81%
ats_utilities/option/ioption_parser.py 25 4 84%
ats_utilities/option/iparser_strategy.py 25 4 84%
ats_utilities/option/option_namespace.py 13 0 100%
ats_utilities/pro_config/__init__.py 9 0 100%
ats_utilities/pro_config/ipro_config.py 22 3 86%
ats_utilities/pro_config/ipro_name.py 22 3 86%
ats_utilities/pro_config/itemplate_dir.py 22 3 86%
ats_utilities/pro_config/pro_config.py 40 1 98%
ats_utilities/pro_config/pro_name.py 38 1 97%
ats_utilities/pro_config/template_dir.py 38 1 97%
ats_utilities/splash/__init__.py 9 0 100%
ats_utilities/splash/ats_splash.py 70 0 100%
ats_utilities/splash/ext_infrastructure.py 40 1 98%
ats_utilities/splash/github_infrastructure.py 47 1 98%
ats_utilities/splash/iext_infrastructure.py 20 3 85%
ats_utilities/splash/iprogress_bar.py 20 3 85%
ats_utilities/splash/isplash.py 14 1 93%
ats_utilities/splash/isplash_screen.py 14 1 93%
ats_utilities/splash/iterminal_properties.py 20 3 85%
ats_utilities/splash/progress_bar.py 45 2 96%
ats_utilities/splash/splash_property.py 39 1 97%
ats_utilities/splash/terminal_properties.py 52 1 98%
Total 3066 159 95%

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.3.7.tar.gz (61.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.3.7-py3-none-any.whl (179.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ats_utilities-3.3.7.tar.gz
  • Upload date:
  • Size: 61.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.3.7.tar.gz
Algorithm Hash digest
SHA256 7c27d02abd7827d59832fb6277696295c49a99db3a659cd1d8389a21299f57ed
MD5 a5b4a677f2fee4d851999cd27c2202fe
BLAKE2b-256 2ccbb45bfb31c060a57c9f21cb315d57a18e2c467aa6de6d9297ce8b266f096f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ats_utilities-3.3.7-py3-none-any.whl
  • Upload date:
  • Size: 179.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.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4633d89bc6d828e0eb159a89a96c6c4a32f39fd604fc8d168a3a7b8e8c90482a
MD5 e6a3997f6f0d60e8c2c814f9de50adce
BLAKE2b-256 03e292e2593d848d53ba7046d49a32e6bf65a380d76d95d0aaa0bec05783a717

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