refactor: add badges and code coverage

.github/workflows/unittest.yml

@@ -4,19 +4,31 @@ jobs:
   pytest:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4 # Checking out the repo
+    # check out repo
+    - uses: actions/checkout@v4
 
+    # install all deps in pipenv
     - name: install_deps
       uses: VaultVulp/[email protected]
       with:
-        command: install -d # Install all dependencies, including development ones
+        command: install -d
 
+    # show installed deps in graph
     - name: show_graph
       uses: VaultVulp/[email protected]
       with:
         command: graph # shows installed pip packages
 
+    # run pytest through coverage package and generate report
     - name: test
       uses: VaultVulp/[email protected]
       with:
-        command: run pytest -vv
+        command: |
+           run pytest -vv --cov --cov-report=xml
+
+    # upload coverage to codecov
+    - name: upload
+      uses: codecov/[email protected]
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        slug: very-doge-wow/stella

.gitignore

@@ -131,3 +131,5 @@ dmypy.json
 output.md
 output.html
 .DS_Store
+.coverage
+coverage.xml

Pipfile

@@ -10,6 +10,7 @@ markdown = "==3.6"
 [dev-packages]
 pyhamcrest = "==2.1.0"
 pytest = "==8.1.1"
+pytest-cov = "==4.1.0"
 
 [requires]
 python_version = "3.11"

README.md

@@ -2,9 +2,13 @@
 
 ![stella](https://github.com/very-doge-wow/stella/blob/main/stella.png?raw=true)
 
-[![Lint Markdown](https://github.com/very-doge-wow/stella/actions/workflows/lintmarkdown.yml/badge.svg)](https://github.com/very-doge-wow/stella/actions/workflows/lintmarkdown.yml)
-[![Unittests](https://github.com/very-doge-wow/stella/actions/workflows/unittest.yml/badge.svg)](https://github.com/very-doge-wow/stella/actions/workflows/unittest.yml)
-[![Docker Pulls](https://img.shields.io/docker/pulls/suchdogewow/stella.svg)](https://hub.docker.com/r/suchdogewow/stella)
+[![markdownlint](https://github.com/very-doge-wow/stella/actions/workflows/lintmarkdown.yml/badge.svg)](https://github.com/very-doge-wow/stella/actions/workflows/lintmarkdown.yml)
+[![unittests](https://github.com/very-doge-wow/stella/actions/workflows/unittest.yml/badge.svg)](https://github.com/very-doge-wow/stella/actions/workflows/unittest.yml)
+[![code coverage](https://img.shields.io/codecov/c/github/very-doge-wow/stella/main)](https://app.codecov.io/github/very-doge-wow/stella)
+[![release](https://img.shields.io/github/v/release/very-doge-wow/stella)](https://github.com/very-doge-wow/stella)
+[![license](https://img.shields.io/github/license/very-doge-wow/stella)](https://github.com/very-doge-wow/stella?tab=MIT-1-ov-file#readme)
+[![docker pulls](https://img.shields.io/docker/pulls/suchdogewow/stella.svg)](https://hub.docker.com/r/suchdogewow/stella)
+[![downloads](https://img.shields.io/github/downloads/very-doge-wow/stella/total)](https://github.com/very-doge-wow/stella/pkgs/container/stella)
 
 `stella` is a free tool to help automatically generate
 [helm](https://helm.sh/) chart documentation.
@@ -24,7 +28,7 @@ link.
 
 ### Docker Image
 
-Using the [OCI image](https://hub.docker.com/r/suchdogewow/stella):
+Using the [Docker image](https://github.com/very-doge-wow/stella/pkgs/container/stella):
 
 <!-- markdownlint-disable MD013 -->
 ```shell