πŸ“¦ EqualifyEverything / equalify-uic-analysis

Accessibiity scan for PDFs and HTML pages

β˜… 1 stars β‘‚ 0 forks πŸ‘ 1 watching βš–οΈ GNU General Public License v3.0
accessibility
πŸ“₯ Clone https://github.com/EqualifyEverything/equalify-uic-analysis.git
HTTPS git clone https://github.com/EqualifyEverything/equalify-uic-analysis.git
SSH git clone git@github.com:EqualifyEverything/equalify-uic-analysis.git
CLI gh repo clone EqualifyEverything/equalify-uic-analysis
Blake Bertuccelli-Booth Blake Bertuccelli-Booth Add updates to README 3f213c8 8 months ago πŸ“ History
πŸ“‚ 3f213c8f3e90e018ed8b611aaf99630902b82a7a View all commits β†’
πŸ“„ .gitignore
πŸ“„ input.csv
πŸ“„ input2.csv
πŸ“„ LICENSE
πŸ“„ output.csv
πŸ“„ README.md
πŸ“„ requirements.txt
πŸ“„ README.md

Equalify UIC PDF Analysis

This project includes two key tools for analyzing PDF accessibility linked in a CSV input file:

Components

1. Equalify UIC PDF Analysis

This script (equalify-uic-pdf-analysis.py) performs automated checks on PDF files. It:
  • Analyzes each PDF's size, page count, text content, and tag structure.
  • Supports PDFs hosted on direct links or Box.com.
  • Submits eligible PDFs for advanced accessibility analysis via Equalify’s scan service.
  • Outputs results to output.csv.

2. Equalify UIC PDF Dashboard

This Streamlit dashboard (equalify-uic-pdf-dashboard.py) provides a visual summary of the analysis results. It:
  • Displays key metrics like total checks passed/failed and number of files.
  • Includes a pie chart and table of failure reasons by description.
  • Reads Equalify result JSONs from the results/ folder.

Getting Started

  • Place your input data in a file called input.csv in the root directory. The file should include a column named Link with PDF or Box file URLs.
  • Run the analysis script:
python equalify-uic-pdf-analysis.py
  • After the analysis completes, start the dashboard:
streamlit run equalify-uic-pdf-dashboard.py

Make sure to install required dependencies (see requirements.txt) and set your Box API credentials in a .env file.

Maintainers

This project is maintained by the Accessibility Engineering team at University of Illinois Chicago (UIC) Technology Solutions.