saharshsingh/tssc-python-package

Trusted Software Supply Chain (TSSC) implemented as a Python library.

tssc-python-package

Trusted Software Supply Chain (TSSC) implemented as a Python library.

Documentation

• Python Package Documentation
• Trusted Software Supply Chain (TSSC) Overview

Install

Latest Release

not yet released

Latest Development Release

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple tssc

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 tssc-python-package
python -m venv .venvs/tssc-dev
source .venvs/tssc-dev/bin/activate
python -m pip install --upgrade pip
python -m pip install -e '.[tests]'

Run Tests

python -m pytest --cov=tssc --cov-report term-missing tests

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

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

Run linter

python -m pylint --rcfile=setup.cfg tssc

Generate the Documentation Locally

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

pip install pdoc3
pdoc3 --html --output-dir pdoc3-html tssc/