Skip to main content

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
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:

  1. Fixes structure automatically -- tags, language, reading order, headings, tables, links, bookmarks
  2. 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 + web UI (everything you need)
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

accesspdf-1.2.0.tar.gz (156.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

accesspdf-1.2.0-py3-none-any.whl (81.3 kB view details)

Uploaded Python 3

File details

Details for the file accesspdf-1.2.0.tar.gz.

File metadata

  • Download URL: accesspdf-1.2.0.tar.gz
  • Upload date:
  • Size: 156.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for accesspdf-1.2.0.tar.gz
Algorithm Hash digest
SHA256 ddc4b9eea41e0de33ea5e56258759e43d1ebff7a051126fc8a2f93543759c983
MD5 ef4d7ad5af326456c9cfb0afb2e250dc
BLAKE2b-256 ac2f807bd129afe77fb16be3b635075404c3585e52df8480a93ca3dc111d67f4

See more details on using hashes here.

File details

Details for the file accesspdf-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: accesspdf-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 81.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for accesspdf-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eda0c273c51d68da08410ad95ae5b178077efb37dac74be8bd0cb14aaaeaf8e5
MD5 04de4bf8704375fc0276755b1464588b
BLAKE2b-256 8b220b7fd224ebd99b346a875f52e9ec6e2e5fca9785c6e6db34d377c6b6cc7b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page