de.fraunhofer.iem:spha-adapter

Library to transform tool results into KPIs and calculate KPI hierarchies.

https://github.com/fraunhofer-iem/spha

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
    Organization fraunhofer-iem has institutional domain (www.iem.fraunhofer.de)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Library to transform tool results into KPIs and calculate KPI hierarchies.

Basic Info
  • Host: GitHub
  • Owner: fraunhofer-iem
  • License: mit
  • Language: Kotlin
  • Default Branch: main
  • Homepage:
  • Size: 939 KB
Statistics
  • Stars: 7
  • Watchers: 4
  • Forks: 2
  • Open Issues: 9
  • Releases: 11
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

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) by creating a pull-request and following the instructions added as a comment. 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

Owner

  • Name: Fraunhofer IEM
  • Login: fraunhofer-iem
  • Kind: organization
  • Location: Paderborn, Germany

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Software Product Health Assistant
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Jan-Niclas
    family-names: Struewer
    email: jan-niclas.struewer@iem.fraunhofer.de
    affiliation: Fraunhofer IEM
    orcid: 'https://orcid.org/0000-0002-4876-3483'
  - orcid: 'https://orcid.org/0000-0001-8285-2343'
    given-names: Benedict
    family-names: Wohlers
    email: benedict.wohlers@iem.fraunhofer.de
    affiliation: Fraunhofer IEM
  - given-names: Sebastian
    family-names: Leuer
    email: sebastian.leuer@iem.fraunhofer.de
    affiliation: Fraunhofer IEM
  - given-names: Matthias
    family-names: Becker
    email: matthias.becker@iem.fraunhofer.de
    affiliation: Fraunhofer IEM
    orcid: 'https://orcid.org/0000-0003-2465-9347'
  - given-names: Hutomo
    family-names: Saleh
    email: hutomo.saleh@iem.fraunhofer.de
    affiliation: Fraunhofer IEM
  - given-names: Lucas
    family-names: Briese
    email: lucas.briese@iem.fraunhofer.de
    affiliation: Fraunhofer IEM
  - name: Fraunhofer IEM
    address: Zukunftsmeile 1
    city: Paderborn
    country: DE
    post-code: '33102'
    email: spha@iem.fraunhofer.de
    website: 'https://www.iem.fraunhofer.de'
repository-code: 'https://github.com/fraunhofer-iem/spha'
url: 'https://software-product.health'
license: MIT

GitHub Events

Total
  • Create event: 20
  • Issues event: 13
  • Release event: 5
  • Watch event: 6
  • Delete event: 13
  • Issue comment event: 40
  • Push event: 83
  • Pull request review comment event: 25
  • Pull request review event: 30
  • Pull request event: 30
  • Fork event: 2
Last Year
  • Create event: 20
  • Issues event: 13
  • Release event: 5
  • Watch event: 6
  • Delete event: 13
  • Issue comment event: 40
  • Push event: 83
  • Pull request review comment event: 25
  • Pull request review event: 30
  • Pull request event: 30
  • Fork event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 1
  • Average time to close issues: 16 days
  • Average time to close pull requests: about 21 hours
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 1
  • Average time to close issues: 16 days
  • Average time to close pull requests: about 21 hours
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • janniclas (9)
Pull Request Authors
  • janniclas (14)
  • hutomosaleh (1)
  • matzebecker (1)
  • janinedenise (1)
  • AnakinRaW (1)
Top Labels
Issue Labels
enhancement (4) documentation (1)
Pull Request Labels
enhancement (5) breaking (2) build (1) bug (1) adapter (1)

Packages

  • Total packages: 3
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 33
repo1.maven.org: de.fraunhofer.iem:spha-adapter

SPHA is a collection of libraries to work with hierarchical KPI models.

  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 33.6%
Average: 40.8%
Dependent packages count: 48.1%
Last synced: 6 months ago
repo1.maven.org: de.fraunhofer.iem:spha-core

SPHA is a collection of libraries to work with hierarchical KPI models.

  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 33.6%
Average: 40.8%
Dependent packages count: 48.1%
Last synced: 6 months ago
repo1.maven.org: de.fraunhofer.iem:spha-model

SPHA is a collection of libraries to work with hierarchical KPI models.

  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 33.6%
Average: 40.8%
Dependent packages count: 48.1%
Last synced: 6 months ago

Dependencies

.github/workflows/gradleBuild.yml actions
  • actions/checkout v4 composite
  • actions/setup-java v4 composite
  • gradle/actions/setup-gradle v4 composite
adapter/build.gradle.kts maven
core/build.gradle.kts maven
model/build.gradle.kts maven
.github/workflows/createTag.yml actions
  • actions/checkout v4 composite
.github/workflows/release.yml actions
  • actions/checkout v4 composite
build.gradle.kts maven
buildSrc/build.gradle.kts maven