AI-powered PDF accessibility remediation, at scale
Project description
AccessPDF
Make PDFs accessible. Fixes structure, reading order, tables, and headings automatically -- then helps you add image descriptions with local AI or by hand.
Targets WCAG 2.1 AA and PDF/UA.
Quick start
pip install "accesspdf[web]"
accesspdf serve
This opens a browser UI at http://localhost:8080. Upload a PDF, get an accessibility report, download the fixed version. If your PDF has images, you can write alt text right in the browser -- or let AI do a first draft.
For AI-generated alt text, we recommend Ollama -- it's free, runs locally, and needs no API key. Install it, then:
ollama pull llava
That's it. Select "Ollama" in the web UI and click generate.
How it works
AccessPDF does two things:
- Fixes structure automatically -- tags, language, reading order, headings, tables, links, bookmarks
- Helps you add image descriptions -- the one part that needs a human (or AI + human review)
Your original PDF is never modified. Output always goes to a new file.
CLI workflow
If you prefer the command line over the web UI:
# 1. See what's wrong (read-only, never touches your file)
accesspdf check my-document.pdf
# 2. Fix structural issues
accesspdf fix my-document.pdf -o my-document_accessible.pdf
# 3. Generate AI alt text drafts (optional)
accesspdf generate-alt-text my-document_accessible.pdf
# 4. Review and approve the drafts
accesspdf review my-document_accessible.pdf
# 5. Re-run fix to inject approved descriptions
accesspdf fix my-document.pdf -o my-document_accessible.pdf --alt-text my-document.alttext.yaml
AI alt text providers
AccessPDF uses AI vision models to draft image descriptions. You always review before anything gets injected.
| Provider | Setup | API key? | Cost |
|---|---|---|---|
| Ollama (recommended) | Install Ollama, ollama pull llava |
No | Free (local) |
| Google Gemini | None | GOOGLE_API_KEY |
Free tier |
| Anthropic (Claude) | pip install accesspdf[anthropic] |
ANTHROPIC_API_KEY |
Paid |
| OpenAI (GPT-4) | pip install accesspdf[openai] |
OPENAI_API_KEY |
Paid |
Ollama is the easiest -- no API key, no account, nothing leaves your machine. Just install it and pull a model.
For cloud providers, set your key as an environment variable or pass it directly:
accesspdf generate-alt-text my-document.pdf --provider gemini --api-key AIza...
In the web UI, you can paste your API key in the settings panel -- it's sent per-request and never saved to disk.
Batch processing
Fix every PDF in a folder:
accesspdf batch ./papers/ -o ./papers/accessible/
accesspdf batch ./papers/ -o ./papers/accessible/ -r # include subdirectories
The sidecar file
Image descriptions live in a .alttext.yaml file next to your PDF:
images:
- id: img_37044c
page: 1
ai_draft: 'Bar chart showing quarterly revenue from 2023-2025.'
alt_text: 'Bar chart showing quarterly revenue. Q1 2025 is highest at $4.2M.'
status: approved
Statuses: needs_review (not yet described), approved (gets injected), decorative (screen readers skip it). You can edit this file by hand.
CLI reference
accesspdf check <pdf> # Analyze accessibility (read-only)
accesspdf fix <pdf> -o <output> # Fix structure + inject alt text
accesspdf fix <pdf> --alt-text <yaml> # Fix with sidecar descriptions
accesspdf batch <dir> -o <outdir> # Fix all PDFs in a directory
accesspdf review <pdf> # Terminal UI for alt text
accesspdf serve # Web UI at localhost:8080
accesspdf generate-alt-text <pdf> # AI drafts (Ollama default)
accesspdf providers # Show available AI providers
Installation options
pip install accesspdf # CLI only
pip install "accesspdf[web]" # CLI + browser UI (recommended)
pip install "accesspdf[anthropic]" # Add Claude provider
pip install "accesspdf[openai]" # Add GPT-4 provider
Contributing
git clone https://github.com/laurenaulet/accesspdf.git
cd accesspdf
pip install -e ".[dev]"
python -m pytest tests/ -v
License
Apache 2.0
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file accesspdf-1.0.0.tar.gz.
File metadata
- Download URL: accesspdf-1.0.0.tar.gz
- Upload date:
- Size: 153.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
52d160c5533a15e11891dff8d08d5d0bb1fd310c5a7eec22c918cc2478c729d3
|
|
| MD5 |
95985f3e473cd31aefb377ee4e8c287a
|
|
| BLAKE2b-256 |
c4da6eae4eb8325c7a57e32baf357948bfc0525af0613e11cfc7f1d80a76d200
|
File details
Details for the file accesspdf-1.0.0-py3-none-any.whl.
File metadata
- Download URL: accesspdf-1.0.0-py3-none-any.whl
- Upload date:
- Size: 78.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
811e536dc881e5dc50a1538e94a437a52f7e20a6c342ffb735f0a6f448c29044
|
|
| MD5 |
7dfd139b52789e5878c50d1ef6b1a21e
|
|
| BLAKE2b-256 |
8645a8933743057bce764cdec92b455f17db87d3fa4b986ef208cb0421db645b
|