feat: README Badges and Execexam Logo

.github/workflows/publish.yml

@@ -0,0 +1,49 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - 'v*'  # Triggers on tags starting with 'v'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'  # Use the Python version compatible with your project
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Install dependencies
+        run: |
+          poetry install
+
+      - name: Configure Poetry for PyPI
+        run: |
+          poetry config repositories.pypi https://upload.pypi.org/legacy/
+          poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
+
+      - name: Publish package to PyPI
+        run: |
+          poetry publish --repository pypi --build
+
+      - name: Check for Successful Publication
+        run: |
+          version=$(poetry version --short)
+          echo "Checking if package execexam version $version is available on PyPI..."
+          response=$(curl -s "https://pypi.org/pypi/execexam/$version/json")
+          if echo "$response" | grep -q "$version"; then
+            echo "Package execexam version $version is successfully published on PyPI."
+          else
+            echo "Package execexam version $version was not found on PyPI."
+            exit 1
+          fi
+

.github/workflows/test-publish.yml

@@ -0,0 +1,48 @@
+name: Test Publish
+
+on:
+  push:
+    tags:
+      - 't*'  # Triggers on tags starting with 't'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '^3.11'  # Use the Python version compatible with your project
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Install dependencies
+        run: |
+          poetry install
+
+      - name: Configure Poetry for TestPyPI
+        run: |
+          poetry config repositories.testpypi https://test.pypi.org/legacy/
+          poetry config pypi-token.testpypi ${{ secrets.TEST_PYPI_TOKEN }}
+
+      - name: Publish package to TestPyPI
+        run: |
+          poetry publish --repository testpypi --build
+
+      - name: Check for Successful Publication
+        run: |
+          version=$(poetry version --short)
+          echo "Checking if package execexam version $version is available on TestPyPI..."
+          response=$(curl -s "https://test.pypi.org/pypi/execexam/$version/json")
+          if echo "$response" | grep -q "$version"; then
+            echo "Package execexam version $version is successfully published on TestPyPI."
+          else
+            echo "Package execexam version $version was not found on TestPyPI."
+            exit 1
+          fi

.gitignore

@@ -375,3 +375,4 @@ credentials.json
 
 # poetry.toml file
 poetry.toml
+

README.md

@@ -1,5 +1,11 @@
 # 🚀 ExecExam
 
+<img src="https://i.ibb.co/vzjX7p2/exe.png" alt="logo" height="500">
+
+[![Coverage](https://img.shields.io/badge/coverage-71%25-orange)](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 Badge](version-badge.svg)
+
 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

badges.py

@@ -0,0 +1,96 @@
+import json
+import re
+import requests
+
+
+def update_coverage_badge():
+    # Load the coverage.json file
+    try:
+        with open("coverage.json") as f:
+            data = json.load(f)
+            print("Loaded coverage.json successfully.")
+    except FileNotFoundError:
+        print("Error: coverage.json file not found. Run your tests first.")
+        return
+
+    # Extract total coverage percentage
+    try:
+        total_coverage = data["totals"]["percent_covered_display"]
+        print(f"Total coverage found: {total_coverage}%")
+    except KeyError:
+        print("Error: Unable to find the total coverage in the report.")
+        return
+
+    # Ensure coverage is formatted properly as an integer
+    total_coverage = int(float(total_coverage))
+
+    # Determine the color based on the coverage percentage
+    if total_coverage >= 90:
+        color = "brightgreen"
+    elif total_coverage >= 75:
+        color = "yellow"
+    elif total_coverage >= 50:
+        color = "orange"
+    else:
+        color = "red"
+
+    print(f"Coverage color set to: {color}")
+
+    # Generate the badge markdown with dynamic color
+    badge = f"![Coverage](https://img.shields.io/badge/coverage-{total_coverage}%25-{color})"
+    print(f"Generated badge: {badge}")
+
+    # Read the README.md and update the badge
+    try:
+        with open("README.md", "r+") as f:
+            content = f.read()
+            if re.search(
+                r"!\[Coverage\]\(https://img.shields.io/badge/coverage-[0-9]+%25-[a-z]+\)",
+                content,
+            ):
+                print("Existing badge found, updating...")
+                new_content = re.sub(
+                    r"!\[Coverage\]\(https://img.shields.io/badge/coverage-[0-9]+%25-[a-z]+\)",
+                    badge,
+                    content,
+                )
+                f.seek(0)
+                f.write(new_content)
+                f.truncate()
+                print("README.md updated successfully.")
+            else:
+                print(
+                    "No existing badge found, please ensure it's in the correct format."
+                )
+    except FileNotFoundError:
+        print("Error: README.md file not found.")
+        return
+
+
+if __name__ == "__main__":
+    update_coverage_badge()
+
+
+# Path to your local JSON file from Open Source Insights
+json_file_path = "version.json"
+
+# Load the JSON data from the file
+with open(json_file_path, "r") as f:
+    data = json.load(f)
+
+# Extract the latest version from the JSON data
+# Adjust this depending on the structure of your JSON file
+latest_version = data["info"]["version"]  # Modify this if necessary
+print(f"Latest version: {latest_version}")
+
+# Now create/update the badge using Shields.io
+badge_url = f"https://img.shields.io/badge/version-{latest_version}-blue.svg"
+
+# Download the badge and save it locally (optional)
+badge_response = requests.get(badge_url)
+if badge_response.status_code == 200:
+    with open("version-badge.svg", "wb") as f:
+        f.write(badge_response.content)
+    print("Badge updated successfully!")
+else:
+    print("Error fetching badge from Shields.io.")

tests/__init__.py

@@ -0,0 +1 @@
+