Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 2.16 KB

README.md

File metadata and controls

51 lines (36 loc) · 2.16 KB

SPHA Logo

About

SPHA is a fully automated tool suite that assesses and communicates all aspects of software product quality. It does so by combining data about your projects from sources like ticketing systems, and static analysis tools. For more details see software-product.health.

SPHA Library

This project contains SPHA's core library. Its main purpose is to calculate a products health score based on a given KpiHierarchy and RawValueKPIs. Further, SPHA provides the possibility to transform tool results into our internal RawValueKPI format. The transformation is handled by dedicated tool adapters.
With the SPHA CLI Tool we have created an executable tool using this library and showcasing its possibilities. A tool demo using our GitHub Action can be found here.

Installation

SPHA is a 100% Kotlin project build with Gradle. You must have Kotlin installed on your system. To use Gradle either install it locally our use the included Gradle wrapper. We aim to always support the latest version of Kotlin and Gradle.

To build the project using the wrapper run ./gradlew build.

Usage

SPHA is divided into three modules core, adapter, and model that are individually published.
To include one of the components use implementation("de.fraunhofer.iem:spha-XXX:VERSION").

Contribute

You are welcome to contribute to SPHA. Please make sure you adhere to our contributing guidelines.
First time contributors are asked to accept our contributor license agreement (CLA). For questions about the CLA please contact us at SPHA(at)iem.fraunhofer.de or create an issue.

License

Copyright (C) Fraunhofer IEM.
Software Product Health Assistant (SPHA) and all its components are published under the MIT license.

Logo IEM