Merge branch 'main' into main

.coveragerc

@@ -0,0 +1,8 @@
+[coverage:report]
+skip_empty = true
+[run]
+relative_files=true
+source=./execexam
+[json]
+show_contexts=True
+pretty_print=True

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,5 +1,3 @@
-# Bug Report
-=======
 ---
 name: Bug report
 about: Create a report to help us improve

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,6 +1,3 @@
-
-# Feature Request
-=======
 ---
 name: Feature request
 about: Suggest an idea for this project

.github/workflows/build.yml

@@ -1,4 +1,3 @@
-# Basic workflow
 name: build
 
 # Use more columns for terminal output
@@ -39,50 +38,46 @@ jobs:
             python-version: "3.12"
           - os: windows-latest
             python-version: "3.12"
+
     # Define the workflow steps
     steps:
     # Checkout the code of the repository
-        - name: Check out Repository Code
-          uses: actions/checkout@v3
-          with:
-            fetch-depth: 0
-        # Setup Python for the current language version
-        - name: Setup Python ${{ matrix.python-version }}
-          if: always()
-          uses: actions/setup-python@v4
-          with:
-            python-version: ${{ matrix.python-version }}
-        # Install pip
-        - name: Install Pip
-          if: always()
-          run: |
-            python -m pip install --upgrade pip
-        # Install poetry
-        - name: Install Poetry
-          if: always()
-          uses: abatilo/[email protected]
-          with:
-            poetry-version: 1.8.3
-        # Install dependencies
-        - name: Install dependencies
-          if: always()
-          run: |
-            poetry install
-        # Run the linters
-        - name: Run Linters
-          if: always()
-          run: |
-            # install ruff directly instead of managing
-            # it as a dependency with Poetry since ruff
-            # does not (always) install correctly
-            # through Poetry on NixOS
-            pipx install ruff
-            poetry run task lint
-        # Run the tests
-        - name: Run Tests
-          if: always()
-          run: |
-            # do not run the Hypothesis-based fuzz tests
-            # because they sometimes take longer to run
-            # on Windows and MacOS and this creates errors
-            poetry run task test-not-fuzz
+      - name: Check out Repository Code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      # Setup Python for the current language version
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      # Install pip
+      - name: Install Pip
+        run: |
+          python -m pip install --upgrade pip
+      # Install poetry
+      - name: Install Poetry
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: 1.8.3
+      # Install dependencies
+      - name: Install dependencies
+        run: |
+          poetry install
+      # Run the linters
+      - name: Run Linters
+        run: |
+          pipx install ruff
+          poetry run task lint
+      # Run the tests
+      - name: Run Tests
+        run: |
+          poetry run task test-not-fuzz
+      # Run the tests and coverage
+      - name: Run Tests and Generate Coverage
+        run: |
+          poetry run pytest -s --cov=my_package --cov-report json:coverage.json
+      # Generate badges
+      - name: Generate Coverage and Version Badges
+        run: |
+          poetry run python scripts/badges.py

.gitignore

@@ -207,6 +207,7 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
+coverage.json
 *,cover
 .hypothesis/
 *.mo
@@ -355,18 +356,6 @@ Temporary Items
 # .txt files
 *.txt
 
-# pytest-cov htmlcov
-htmlcov
-
-# coverage report
-.coveragereport.json
-
-# coverage report
-coverage.txt
-
-# coverage report
-coverage.json
-
 # bash command history
 .bash_history
 
@@ -375,3 +364,4 @@ credentials.json
 
 # poetry.toml file
 poetry.toml
+

README.md

@@ -1,5 +1,12 @@
 # 🚀 ExecExam
 
+<img src="https://i.ibb.co/vzjX7p2/exe.png" alt="logo" height="500">
+
+[![coverage](https://img.shields.io/badge/coverage-20.86%25-brightgreen)](https://github.com/GatorEducator/execexam/actions)
+[![Static Badge](https://img.shields.io/badge/Maintained%3F-yes-orange)](https://github.com/GatorEducator/execexam/commits/main/)
+![version](https://img.shields.io/badge/version-0.3.0-blue)
+
+
 ExecExam is a powerful tool that runs executable examinations in which a
 student provides solutions to programming problems that are checked by Pytest
 test suites. If you are a computer science or software engineering instructor