Merge branch 'main' into example-failed-unittest

Author: JuliusWiedemann

Diff for: .github/workflows/python-ci.yml

@@ -1,18 +1,17 @@
 name: Python CI Example
 
-on: [push, pull_request]
+on: [push, pull_request, workflow_dispatch]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
     steps:
+
     - name: Checkout repository
       uses: actions/checkout@v4
 
     - name: Set up Python V3.11
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.11
 
@@ -21,14 +20,75 @@ jobs:
         python -m pip install --upgrade pip
         pip install -r requirements.txt
 
+    - name: Set default environment variables
+      run: |
+        echo "mypy_warnings=INVALID" >> $GITHUB_ENV
+        echo "pylint_score=INVALID" >> $GITHUB_ENV
+        echo "coverage=INVALID" >> $GITHUB_ENV
+
+    - name: Run type checker
+      run: |
+        mypy source | tee mypy_output.txt
+        MYPY_WARNINGS=$(grep -oP '\b\d+(?= errors?)|\bno issues found\b' mypy_output.txt | tail -n1 | sed 's/\bno issues found\b/0/')
+        echo "mypy_warnings=${MYPY_WARNINGS}" >> $GITHUB_ENV
+      continue-on-error: true
+
+    - name: Run static code analysis
+      run: |
+        pylint --output-format=parseable main.py source tests | tee pylint_output.txt
+        PYLINT_SCORE=$(grep -oP 'Your code has been rated at \K[^/]+' pylint_output.txt)
+        echo "pylint_score=${PYLINT_SCORE}" >> $GITHUB_ENV
+      continue-on-error: true
+
     - name: Run unittests
       run: |
         python -m unittest discover -v
-       
+
     - name: Run coverage
       run: |
         coverage run -m unittest discover
         coverage report -m 
+        coverage json -o coverage.json
 
-    - name: Run static code analysis
-      run: pylint main.py source tests
+        COVERAGE_PERCENT=$(python -c "import json; print(round(json.load(open('coverage.json'))['totals']['percent_covered'], 2))")
+        echo "coverage=${COVERAGE_PERCENT}" >> $GITHUB_ENV
+
+    - name: Create mypy warning badge
+      if: always()
+      uses: schneegans/dynamic-badges-action@v1.7.0
+      with:
+        auth: ${{ secrets.GIST_SECRET }}
+        gistID: d506acc54dead9ca1d070488e813d253
+        filename: mypy_warnings.json 
+        label: MyPy Warnings
+        message: ${{ env.mypy_warnings }}
+        valColorRange: ${{ env.mypy_warnings }}
+        minColorRange: 1
+        maxColorRange: 6
+        invertColorRange: true
+
+    - name: Create pylint badge
+      if: always()
+      uses: schneegans/dynamic-badges-action@v1.7.0
+      with:
+        auth: ${{ secrets.GIST_SECRET }}
+        gistID: d506acc54dead9ca1d070488e813d253
+        filename: pylint-score.json 
+        label: Pylint Score
+        message: ${{ env.pylint_score }}
+        valColorRange: ${{ env.pylint_score }}
+        minColorRange: 5
+        maxColorRange: 9
+
+    - name: Create coverage badge
+      if: always()
+      uses: schneegans/dynamic-badges-action@v1.7.0
+      with:
+        auth: ${{ secrets.GIST_SECRET }}
+        gistID: d506acc54dead9ca1d070488e813d253
+        filename: coverage.json 
+        label: Coverage
+        message: ${{ env.coverage }}%
+        valColorRange: ${{ env.coverage }}%
+        minColorRange: 50
+        maxColorRange: 90

Diff for: README.md

@@ -1,13 +1,30 @@
+![ci build results](https://github.com/JuliusWiedemann/PythonCIExample/actions/workflows/python-ci.yml/badge.svg)
+![pylint-score](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/JuliusWiedemann/d506acc54dead9ca1d070488e813d253/raw/pylint-score.json)
+![mypy-warnings](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/JuliusWiedemann/d506acc54dead9ca1d070488e813d253/raw/mypy_warnings.json)
+![coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/JuliusWiedemann/d506acc54dead9ca1d070488e813d253/raw/coverage.json)
+[![license](https://img.shields.io/badge/License-MIT-purple.svg)](LICENSE)
+
 # 🏗️ Python Continuous Integration - Example 
 
-This repo shows a basic example of CI/CD in python with github actions
+This repository shows a basic example of CI/CD in python with [![GitHub Actions](https://img.shields.io/badge/GitHub_Actions-2088FF?logo=github-actions&logoColor=white)](#). It can be used as a template to set up a new [![Python](https://img.shields.io/badge/Python-3776AB?logo=python&logoColor=fff)](#) project.
+
+Navigate to the branch [example-failed-unittest](https://github.com/JuliusWiedemann/PythonCIExample/tree/example-failed-unittest) or [example-failed-pylint](https://github.com/JuliusWiedemann/PythonCIExample/tree/example-failed-pylint) to view what a failed build will look like.
 
 ## Features
-- 🗒️ Static code analysis with pylint
-- 🧑‍🔬 Testing with python unittest module
-- ✏️ Code coverage with coverage module
+- Static code analysis with [pylint](https://www.pylint.org/).
+- Type checking with [mypy](https://www.mypy-lang.org/).
+- Testing with python [unittest](https://docs.python.org/3/library/unittest.html) module.
+- Code coverage with [coverage](https://pypi.org/project/coverage/) module.
+
+## Usage
+- Download the source code and use it as a template for your new python project.
+- You need to follow [this](https://github.com/marketplace/actions/dynamic-badges) configuration to use the dynamic badges. Alternative: Just remove the "Create Badge" step from the yml file to disable the feature.
 
 ## Output
+- This template uses [GitHub Actions](https://docs.github.com/en/actions) to run all the tools. It will generate dynamic badges with the [dynamic-badges](https://github.com/marketplace/actions/dynamic-badges) action.
+- Alternatively you can just look at the console output: [GitHub Actions Output](https://github.com/JuliusWiedemann/PythonCIExample/actions).
+
+An example build can look like this:
 ![](images/ci-report.png)
 
 ---

Diff for: mypy.ini

@@ -0,0 +1,9 @@
+[mypy]
+exclude = tests
+warn_return_any = True
+warn_unused_configs = True
+ignore_missing_imports = True
+
+disallow_untyped_defs = True
+disallow_untyped_calls = True
+disallow_incomplete_defs = True

Diff for: requirements.txt

@@ -6,91 +6,91 @@
 # pylint: disable=E0401 # False positive
 from pokemon import Pokemon
 
-def welcome():
+def welcome() -> None:
     """
     Prints the welcome message
     """
     print("Welcome to the pokemon game!")
 
-def createNewPokemon():
+def createNewPokemon() -> Pokemon | bool:
     """
     Lets the user create a new pokemon via text input
     Returns the new pokemon
     """
-    name = input("Please enter the name of your pokemon: ")
+    name: str = input("Please enter the name of your pokemon: ")
     if name is None or name == "":
         print("Invalid name")
         return False
 
     try:
-        number = int(input("Please enter the number of your pokemon: "))
+        number: int = int(input("Please enter the number of your pokemon: "))
     except ValueError:
         print("Invalid number")
         return False
 
-    pokeType = input("Please enter the type of your pokemon: ")
+    pokeType: str = input("Please enter the type of your pokemon: ")
 
-    newPokemon = Pokemon(name, number, pokeType)
-    print(f"Your created the following pokemon: {newPokemon}")
+    newPokemon: Pokemon = Pokemon(name, number, pokeType)
+    print(f"You created the following pokemon: {newPokemon}")
     return newPokemon
 
-def attackPokemon(pokemonStorage):
+def attackPokemon(pokemonStorage: dict) -> bool:
     """
     Allows the user to attack a pokemon
     """
     if (len(pokemonStorage.keys())) < 2:
         print("You need at least 2 pokemon to fight.")
         return False
 
-    name1 = input("Enter the name of your pokemon: ")
-    pokemon1 = getPokemon(pokemonStorage, name1)
+    name1: str = input("Enter the name of your pokemon: ")
+    pokemon1: Pokemon = getPokemon(pokemonStorage, name1)
     if not pokemon1:
         return False
 
     name2 = input("Enter the name of the pokemon to attack: ")
-    pokemon2 = getPokemon(pokemonStorage, name2)
+    pokemon2: Pokemon = getPokemon(pokemonStorage, name2)
     if not pokemon2:
         return False
 
     pokemon1.attack(pokemon2)
     return True
 
-def viewPokemonStats(pokemonStorage):
+def viewPokemonStats(pokemonStorage: dict) -> None:
     """
     Allows the user to view stats of one pokemon he created
     """
     name = input("Enter the name of your pokemon: ")
 
-    pokemon = getPokemon(pokemonStorage, name)
+    pokemon: Pokemon = getPokemon(pokemonStorage, name)
     if pokemon:
         print(pokemon)
 
-def getPokemon(pokemonStorage, name):
+def getPokemon(pokemonStorage: dict, name: str) -> Pokemon | bool:
     """
     Searches a pokemon by name from the pokemon storage and returns it
     Returns false if pokemon does not exist
     """
-    pokemon = pokemonStorage.get(name)
+    pokemon: Pokemon = pokemonStorage.get(name)
     if pokemon is None:
         print(f"Sorry. The pokemon {name} does not exist.")
         return False
     return pokemon
 
-def main():
+def main() -> None:
     """
     Creates while loop which lets the user create and fight pokemon via text input
     """
-    game = True
-    pokemonStorage = {}
+    game: bool = True
+    pokemonStorage: dict = {}
 
     welcome()
     while game:
         print("\n\n--------------------------------\n\n")
 
-        choice = input("What to you want to do?\n1: Create new pokemon\n2: Attack a pokemon\n3: View Stats\nQ: Quit Game\n")
+        choice: str = input("What to you want to do?\n1: Create new pokemon\n2: Attack a pokemon\n3: View Stats\nQ: Quit Game\n")
 
         if choice == "1":
-            newPokemon = createNewPokemon()
+            newPokemon: Pokemon = createNewPokemon()
             if newPokemon:
                 pokemonStorage[newPokemon.getName()] = newPokemon
         elif choice == "2":