Merge remote-tracking branch 'origin/main'

.github/workflows/publish-coverage.yml

@@ -0,0 +1,39 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: coverage
+
+on:
+  push:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.9"
+        cache: 'pip'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Test with pytest
+      run: |
+        pip install pytest pytest-cov
+        pytest --cov=shapiq --cov-report=xml
+
+    - name: Coveralls
+      uses: coverallsapp/github-action@v2
+      with:
+        path-to-lcov: coverage.xml

.github/workflows/unit-tests.yml

@@ -0,0 +1,38 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: unit-tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        
+    - name: Test with pytest
+      run: |
+        pip install pytest
+        pytest

README.md

@@ -3,18 +3,36 @@
 </p>
 
 <p align="center">
+  <!-- Tests -->
+  <a href="https://github.com/mmschlk/shapiq/actions/workflows/unit-tests.yml">
+    <img src="https://github.com/mmschlk/shapiq/actions/workflows/unit-tests.yml/badge.svg" alt="unit-tests">
+  </a>
+
+  <!-- Coverage Test -->
+  <a href='https://coveralls.io/github/mmschlk/shapiq'>
+    <img src='https://coveralls.io/repos/github/mmschlk/shapiq/badge.svg' alt='Coverage Status' />
+  </a>
+
   <!-- Read the Docs -->
   <a href='https://shapiq.readthedocs.io/en/latest/?badge=latest'>
       <img src='https://readthedocs.org/projects/shapiq/badge/?version=latest' alt='Documentation Status' />
   </a>
+
   <!-- PyPI Version -->
   <a href="https://pypi.org/project/shapiq">
     <img src="https://img.shields.io/pypi/v/shapiq.svg?color=blue" alt="PyPi">
   </a>
+
   <!-- PyPI status -->
   <a href="https://pypi.org/project/shapiq">
     <img src="https://img.shields.io/pypi/status/shapiq.svg?color=blue" alt="PyPi_status
   </a>
+      
+  <!-- PePy -->
+  <a href="https://pepy.tech/project/shapiq">
+    <img src="https://static.pepy.tech/badge/shapiq?style=flat-square" alt="pepy">
+  </a>
+      
   <!-- License -->
   <a href="https://opensource.org/licenses/MIT">
     <img src="https://img.shields.io/badge/License-MIT-brightgreen.svg" alt="mit_license">