๐Ÿ“ฆ EqualifyEverything / equalify-uic-dashboard-red-theme

Dashboard tool for Equalify UIC Analysis results.

โ˜… 0 stars โ‘‚ 0 forks ๐Ÿ‘ 0 watching โš–๏ธ MIT License
๐Ÿ“ฅ Clone https://github.com/EqualifyEverything/equalify-uic-dashboard-red-theme.git
HTTPS git clone https://github.com/EqualifyEverything/equalify-uic-dashboard-red-theme.git
SSH git clone git@github.com:EqualifyEverything/equalify-uic-dashboard-red-theme.git
CLI gh repo clone EqualifyEverything/equalify-uic-dashboard-red-theme
Blake Bertuccelli-Booth Blake Bertuccelli-Booth add content 3f63d4a 8 months ago ๐Ÿ“ History
๐Ÿ“‚ main View all commits โ†’
๐Ÿ“„ .DS_Store
๐Ÿ“„ .gitignore
๐Ÿ“„ LICENSE
๐Ÿ“„ output-sample.csv
๐Ÿ“„ README.md
๐Ÿ“„ requirements.txt
๐Ÿ“„ README.md

UIC Red Theme Accessibility Report Generator

This Python CLI app processes accessibility scan results for public URLs on the UIC Red Theme website. It generates summary reports including:

  • Pages Scanned: Total number of public URLs scanned
  • Total Violations: Total number of accessibility violations found
  • Unique Nodes: Total number of unique HTML nodes with violations

File Structure

  • output.csv: Contains metadata and links to individual scan result JSON files
  • results/: Folder containing individual JSON files with accessibility violation data
  • equalify-uic-dashboard-red-theme.py: Python CLI script to generate accessibility reports

How to Run the Report Generator

1. Clone the repository

git clone https://github.com/YOUR_ORG/equalify-uic-dashboard-red-theme.git
cd equalify-uic-dashboard-red-theme

2. Install dependencies

Make sure you have Python 3.8+ and pip installed. Then run:

python3 -m venv venv
source venv/bin/activate  # On macOS/Linux
venv\Scripts\activate     # On Windows
pip install -r requirements.txt

3. Add Data Files

Ensure you have:

  • output.csv in the root directory
  • A results/ folder containing all JSON files referenced in output.csv

4. Run the report generator

python equalify-uic-dashboard-red-theme.py

The script will process the data and generate CSV reports.

Output CSV Files

The script generates the following CSV files:

  • output-summary.csv: Summary of scan results including pages scanned, total violations, and unique nodes.
  • output-nodes.csv: Details of unique HTML nodes where violations were found.
  • output-violation_messages.csv: List of distinct violation messages identified during scans.

License

This project is open source and available under the MIT License.