diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml index 3a5649b..57d4dda 100644 --- a/.github/workflows/deploy-docs.yaml +++ b/.github/workflows/deploy-docs.yaml @@ -1,4 +1,4 @@ -name: Deploy docs +name: GitHub Pages on: push: diff --git a/.github/workflows/run-tests.yaml b/.github/workflows/run-tests.yaml index 4a80535..93d7508 100644 --- a/.github/workflows/run-tests.yaml +++ b/.github/workflows/run-tests.yaml @@ -1,7 +1,7 @@ # This workflow will install Python dependencies, run tests and lint with a variety of Python versions # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions -name: Run tests +name: Tests, Code Quality and Documentation on: push: @@ -18,7 +18,7 @@ env: POETRY_VERSION: 1.6.1 jobs: - test: + test-and-coverage: runs-on: ${{ matrix.os }} timeout-minutes: 10 strategy: @@ -43,6 +43,11 @@ jobs: - name: Run tests run: | poetry run pytest --cov=pystatis tests + - name: Update coverage report + run: | + poetry run coverage run -m pytest + poetry run coverage json -o assets/coverage.json + code-quality: runs-on: ${{ matrix.os }} timeout-minutes: 10 @@ -78,6 +83,7 @@ jobs: run: poetry run safety check - name: Run mypy run: poetry run mypy src + sphinx-documentation: runs-on: ${{ matrix.os }} timeout-minutes: 10 diff --git a/README.md b/README.md index 123c6c6..f4831ce 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # ``pystatis`` +![Tests, Code Quality and Documentation](https://github.com/CorrelAid/pystatis/actions/workflows/run-tests.yaml/badge.svg?event=push) +![Code Coverage](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgithub.com%2FCorrelAid%2Fpystatis%2Ftree%2Ffeature%2Ftest-coverage-improval%2Fassets%2Fcoverage.json&query=%24.totals.percent_covered_display&label=Code%20Coverage +) +![GitHub Pages Documentation](https://github.com/CorrelAid/pystatis/actions/workflows/deploy-docs.yaml/badge.svg?event=push) + ```pystatis``` is a Python wrapper for the different GENESIS web service interfaces (API). Currently we are supporting the following databases: - [GENESIS-Online](https://www-genesis.destatis.de/genesis/online)