Skip to the content.

ATS Utilities

☯️ ats_utilities is framework for creating Apps/Tools/Scripts.

Developed in 🐍 python code.

codecov circleci

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 python2 build ats_utilities python3 build

Currently there are four ways to install framework

Install using pip

Python 📦 is located at pypi.org.

You can install by using pip

# python2
pip2 install ats-utilities
# 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
# python2
wget https://bootstrap.pypa.io/pip/2.7/get-pip.py
python2 get-pip.py
python2 -m pip install --upgrade setuptools
python2 -m pip install --upgrade pip
python2 -m pip install --upgrade build
pip2 install -r requirements.txt
python2 -m build --no-isolation --wheel
pip2 install dist/ats-utilities-x.y.z-py2-none-any.whl
rm -f get-pip.py
# 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
# python2
wget https://bootstrap.pypa.io/pip/2.7/get-pip.py
python2 get-pip.py
python2 -m pip install --upgrade setuptools
python2 -m pip install --upgrade pip
python2 -m pip install --upgrade build
pip2 install -r requirements.txt
python2 setup.py install_lib
python2 setup.py install_egg_info
rm -f get-pip.py
# 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 🚢.

ats_utilities docker checker

Dependencies

These modules requires other modules and libraries (Python 2.x/3.x)

Framework structure

ats_utilities is based on OOP.

framework structure

🧰 Framework structure

ats_utilities/
├── abstract/
│   └── __init__.py
├── checker/
│   └── __init__.py
├── cli/
│   ├── cfg_cli.py
│   ├── ini_cli.py
│   ├── __init__.py
│   ├── json_cli.py
│   ├── xml_cli.py
│   └── yaml_cli.py
├── config_io/
│   ├── base_check.py
│   ├── base_read.py
│   ├── base_write.py
│   ├── cfg/
│   │   ├── cfg2object.py
│   │   ├── __init__.py
│   │   └── object2cfg.py
│   ├── ini/
│   │   ├── ini2object.py
│   │   ├── __init__.py
│   │   └── object2ini.py
│   ├── __init__.py
│   ├── json/
│   │   ├── __init__.py
│   │   ├── json2object.py
│   │   └── object2json.py
│   ├── xml/
│   │   ├── __init__.py
│   │   ├── object2xml.py
│   │   └── xml2object.py
│   └── yaml/
│       ├── __init__.py
│       ├── object2yaml.py
│       └── yaml2object.py
├── console_io/
│   ├── error.py
│   ├── __init__.py
│   ├── success.py
│   ├── verbose.py
│   └── warning.py
├── cooperative/
│   └── __init__.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
├── final/
│   └── __init__.py
├── info/
│   ├── ats_build_date.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_name.py
│   ├── ats_logger_status.py
│   └── __init__.py
├── option/
│   └── __init__.py
├── register/
│   └── __init__.py
├── singleton/
│   ├── base.py
│   ├── functional.py
│   ├── __init__.py
│   ├── meta.py
│   └── meta_thread.py
└── splash/
    ├── ext_infrastructure.py
    ├── github_infrastructure.py
    ├── __init__.py
    ├── progress_bar.py
    ├── splash_property.py
    └── terminal_properties.py

19 directories, 67 files

Docs

Documentation Status

📗 More documentation and info at

Contributing

🌎 🌍 🌏 Contributing to ats_utilities

license: gpl v3 license apache 2.0

Copyright (C) 2017 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 2.x/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