README.md

ploigos-step-runner

Ploigos Step Runner (PSR) implemented as a Python library.

Documentation

• Python Package Documentation
• Ploigos Overview

Install

Latest Release

pip install ploigos-step-runner

Latest Development Release

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple ploigos-step-runner

Development

⚠️ If you are running RHEL7 or older versions of Python: This project will need Python 3.3 or better to run. If you are running on RHEL7, you can invoke python3 in place of python in the following commands.

Set Up Development Environment

cd ploigos-step-runner
python -m venv .venvs/psr-dev
source .venvs/psr-dev/bin/activate
python -m pip install --upgrade pip
python -m pip install -e '.[tests]'

Run Tests

tox -e test

Or to run for just a particular implementer, and include the sections of code that you didn't cover

python3 -m pytest --cov --cov-report term-missing tests/step_implementers/package/test_maven_package.py

Run linter

tox -e lint

Run linter and all tests (a good idea before a commit)

tox

Generate the Documentation Locally

If you are updating the python documentation and want to generate locally this is how you do it.

tox -e docs