Update boilerplate (#11)

* Refactor workflows to use PACKAGE_NAME environment variable for consistency

* Remove unused FastAPI badge from Software Maintenance Guide

* Update coverage source to include tests

* Update packages

Author: javidahmed64592

.github/workflows/build.yml

@@ -8,8 +8,11 @@ on:
     branches:
       - main
 
+env:
+  PACKAGE_NAME: example
+
 jobs:
-  build_wheel:
+  build-wheel:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -20,29 +23,28 @@ jobs:
       - name: Inspect wheel contents
         run: |
           echo "Wheel contents:"
-          unzip -l dist/example-*-py3-none-any.whl
+          unzip -l dist/${{ env.PACKAGE_NAME }}-*-py3-none-any.whl
       - name: Upload wheel
         uses: actions/upload-artifact@v4
         with:
-          name: example_wheel
-          path: dist/example-*-py3-none-any.whl
+          name: ${{ env.PACKAGE_NAME }}_wheel
+          path: dist/${{ env.PACKAGE_NAME }}-*-py3-none-any.whl
 
-  verify_structure:
+  verify-structure:
     runs-on: ubuntu-latest
-    needs: build_wheel
+    needs: build-wheel
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup-python-core
 
       - name: Download wheel artifact
         uses: actions/download-artifact@v4
         with:
-          name: example_wheel
+          name: ${{ env.PACKAGE_NAME }}_wheel
 
       - name: Install wheel
         run: |
-          PACKAGE_NAME="example"
-          WHEEL_FILE=$(find . -name "${PACKAGE_NAME}-*-py3-none-any.whl")
+          WHEEL_FILE=$(find . -name "${{ env.PACKAGE_NAME }}-*-py3-none-any.whl")
 
           if [ ! -f "$WHEEL_FILE" ]; then
             echo "Wheel file not found"
@@ -54,16 +56,14 @@ jobs:
 
       - name: Verify installed package structure
         run: |
-          PACKAGE_NAME="example"
-
           # Find site-packages directory
           SITE_PACKAGES=$(find . -name "site-packages" -type d | head -1)
           echo "Site-packages directory: $SITE_PACKAGES"
 
           # Check for required directories in site-packages
           echo "Checking required directories in site-packages..."
           REQUIRED_DIRS=(
-            "${SITE_PACKAGES}/${PACKAGE_NAME}"
+            "${SITE_PACKAGES}/${{ env.PACKAGE_NAME }}"
           )
 
           for dir in "${REQUIRED_DIRS[@]}"; do
@@ -86,7 +86,3 @@ jobs:
               exit 1
             fi
           done
-
-          # Show directory structure
-          echo "Package structure in site-packages:"
-          tree "${SITE_PACKAGES}/${PACKAGE_NAME}" --dirsfirst -F -L 2

.github/workflows/ci.yml

@@ -8,6 +8,9 @@ on:
     branches:
       - main
 
+env:
+  PACKAGE_NAME: example
+
 jobs:
   validate-pyproject:
     runs-on: ubuntu-latest
@@ -53,7 +56,7 @@ jobs:
       - uses: ./.github/actions/setup-python-dev
       - name: Security check
         run: |
-          uv run bandit -r example/ -f json -o bandit-report.json || true
+          uv run bandit -r ${{ env.PACKAGE_NAME }} -f json -o bandit-report.json || true
       - uses: actions/upload-artifact@v4
         with:
           name: bandit-report
@@ -75,9 +78,8 @@ jobs:
         run: |
           echo "Checking version consistency across all package files..."
 
-          PACKAGE_NAME="example"
           TOML_VERSION=$(uv run python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")
-          LOCK_VERSION=$(uv run python -c "import tomllib; lock_data = tomllib.load(open('uv.lock', 'rb')); pkg = next((p for p in lock_data['package'] if p['name'] == '${PACKAGE_NAME}'), None); print(pkg['version'] if pkg else 'not found')")
+          LOCK_VERSION=$(uv run python -c "import tomllib; lock_data = tomllib.load(open('uv.lock', 'rb')); pkg = next((p for p in lock_data['package'] if p['name'] == '$(echo ${{ env.PACKAGE_NAME }} | tr '_' '-')'), None); print(pkg['version'] if pkg else 'not found')")
 
           echo "Version in pyproject.toml: $TOML_VERSION"
           echo "Version in uv.lock: $LOCK_VERSION"

README.md

@@ -13,7 +13,6 @@ This repository can be used as a template for a Python application.
 - [Documentation](#documentation)
 - [License](#license)
 
-
 ## Documentation
 
 - **[Software Maintenance Guide](./docs/SMG.md)**: Development setup, configuration

docs/SMG.md

@@ -15,7 +15,6 @@ This document outlines how to configure and setup a development environment to w
 [![Python](https://img.shields.io/badge/Python-3.13-3776AB?style=flat-square&logo=python&logoColor=ffd343)](https://docs.python.org/3.13/)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json&style=flat-square)](https://github.com/astral-sh/uv)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat-square)](https://github.com/astral-sh/ruff)
-[![FastAPI](https://img.shields.io/badge/FastAPI-Latest-009688?style=flat-square&logo=fastapi&logoColor=white)](https://fastapi.tiangolo.com/)
 
 ### Directory Structure
 
@@ -49,7 +48,7 @@ uv sync --extra dev
 After installing dev dependencies, set up pre-commit hooks:
 
 ```sh
-    uv run pre-commit install
+uv run pre-commit install
 ```
 
 ### Testing, Linting, and Type Checking

docs/WORKFLOWS.md

@@ -33,7 +33,7 @@ It consists of the following jobs:
 ### bandit
 - Checkout code
 - Setup Python environment with dev dependencies (via custom action)
-- Run security scanning with bandit
+- Run security scanning with bandit on `example/` directory
 - Generate JSON report for artifacts
 - Fail if security vulnerabilities are found
 
@@ -52,17 +52,17 @@ It consists of the following jobs:
 The Build workflow runs on pushes and pull requests to the `main` branch.
 It consists of the following jobs:
 
-### build_wheel
+### build-wheel
 - Checkout code
 - Setup Python environment with dev dependencies (via custom action)
 - Build wheel with `uv build`
 - Inspect wheel contents for verification
 - Upload wheel artifact (`example_wheel`)
 
-### verify_structure
-- Depends on `build_wheel` job
+### verify-structure
+- Depends on `build-wheel` job
 - Checkout code
 - Setup Python environment (via custom action)
 - Download wheel artifact
 - Install wheel using `uv pip install`
-- Verify installed package structure
+- Verify installed package structure in site-packages

pyproject.toml

@@ -17,9 +17,7 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
     "License :: OSI Approved :: MIT License",
 ]
-dependencies = [
-    "numpy",
-]
+dependencies = []
 
 [project.optional-dependencies]
 dev = [
@@ -59,7 +57,7 @@ addopts = [
 
 [tool.coverage.run]
 branch = true
-source = ["example"]
+source = ["example", "tests"]
 
 [tool.coverage.report]
 fail_under = 80