ats_coverage
Generate code coverage and update README.md
ats_coverage is toolset for generation of code coverage and update README.md.
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.
Table of Contents
Installation
Used next development environment
Currently there are three ways to install package
- 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
ats_coverage is located at pypi.org.
You can install by using pip
# python3
pip3 install ats_coverage
Install using build
Navigate to release page download and extract release archive.
To install ats_coverage type the following
tar xvzf ats_coverage-x.y.z.tar.gz
cd ats_coverage-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_coverage-*-py3-none-any.whl
rm -f get-pip.py
chmod 755 /usr/local/lib/python3.10/dist-packages/usr/local/bin/ats_coverage_run.py
ln -s /usr/local/lib/python3.10/dist-packages/usr/local/bin/ats_coverage_run.py /usr/local/bin/ats_coverage_run.py
Install using py setup
Navigate to release page download and extract release archive.
To install ats_coverage locate and run setup.py with arguments
tar xvzf ats_coverage-x.y.z.tar.gz
cd ats_coverage-x.y.z
# python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info
Install using docker
You can use Dockerfile to create image/container.
Dependencies
ats_coverage requires next modules and libraries
- ats-utilities - Python App/Tool/Script Utilities
- coverage - Code coverage measurement for Python.
- pathlib - Object-oriented filesystem paths
Tool structure
ats_coverage is based on OOP.
Tool structure
ats_coverage/
├── conf/
│ ├── ats_coverage.cfg
│ ├── ats_coverage.logo
│ └── ats_coverage_util.cfg
├── __init__.py
├── log/
│ └── ats_coverage.log
├── pro/
│ └── __init__.py
├── py.typed
└── run/
└── ats_coverage_run.py
5 directories, 8 files
Code coverage
| Name | Stmts | Miss | Cover |
|---|---|---|---|
| ats_coverage/__init__.py | 70 | 12 | 83% |
| ats_coverage/pro/__init__.py | 124 | 11 | 91% |
| TOTAL | 194 | 23 | 88% |
Docs
More documentation and info at
Contributing
Copyright and licence
Copyright (C) 2024 by vroncevic.github.io/ats_coverage
ats_coverage 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.
