Skip to content

Commit

Permalink
Add badges, update workflows & names #24
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcoHuebner committed Mar 3, 2024
1 parent 3da9b9b commit 964ad77
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy-docs.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Deploy docs
name: GitHub Pages

on:
push:
Expand Down
10 changes: 8 additions & 2 deletions .github/workflows/run-tests.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -18,7 +18,7 @@ env:
POETRY_VERSION: 1.6.1

jobs:
test:
test-and-coverage:
runs-on: ${{ matrix.os }}
timeout-minutes: 10
strategy:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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%2Fgh.neting.cc%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)
Expand Down

0 comments on commit 964ad77

Please sign in to comment.