Skip to main content

Local PDF review with browser UI and Acrobat-compatible highlights

Project description

PeerFold

Review PDFs in a native window. Highlights are standard PDF annotations — open the saved copy in any reader.

Saved reviews: manuscript_VC-2026-06-09.pdf next to the original.

Install

macOS & Linux

curl -fsSL https://vincenzoml.github.io/PeerFold/install.sh | bash

Windows (PowerShell)

irm https://vincenzoml.github.io/PeerFold/install.ps1 | iex

Python 3.10+

python3 -m pip install --user peerfold-review
peerfold manuscript.pdf --reviewer RB

Over SSH: peerfold paper.pdf --web

Shared folder or git repo

One launcher file — pinned PyPI version, same build for every co-author. Do not submodule PeerFold.

One-liner (from project root):

mkdir -p scripts && curl -fsSL https://vincenzoml.github.io/PeerFold/peerfold.py -o scripts/peerfold.py && echo '.venv-peerfold/' >> .gitignore
python3 scripts/peerfold.py manuscript.pdf --reviewer AB

Or download peerfold.pyscripts/peerfold.py, add .venv-peerfold/ to .gitignore.

Upgrade when needed:

python3 scripts/peerfold.py --update   # then commit scripts/peerfold.py

Site: vincenzoml.github.io/PeerFold

Usage

peerfold paper.pdf                  # native window (default)
peerfold paper.pdf -r VC            # reviewer short name
peerfold paper.pdf --web            # system browser (SSH)
peerfold paper.pdf --no-browser     # server only

Environment: PEERFOLD_REVIEWER sets the default reviewer name. Set PEERFOLD_SAVE_COPY=1 to write sidecar files (paper_VC-2026-06-09.pdf) instead of editing in place.

Development

python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
peerfold sample.pdf
pytest

License

MIT — see LICENSE. Uses PyMuPDF (AGPL).

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

peerfold_review-0.1.34.tar.gz (121.1 kB view details)

Uploaded Source

Built Distribution

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

peerfold_review-0.1.34-py3-none-any.whl (121.3 kB view details)

Uploaded Python 3

File details

Details for the file peerfold_review-0.1.34.tar.gz.

File metadata

  • Download URL: peerfold_review-0.1.34.tar.gz
  • Upload date:
  • Size: 121.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for peerfold_review-0.1.34.tar.gz
Algorithm Hash digest
SHA256 51c10734f423d03993d2980ec87e54416821abc73652853a6bc44730bb06272b
MD5 b53b797200ef4f57f339a3a52e6bff8d
BLAKE2b-256 7ced869fdbb96e4b2155b8320dbd16b24d613ad1718cb9b6d6f9e0d8a7b7d6ba

See more details on using hashes here.

File details

Details for the file peerfold_review-0.1.34-py3-none-any.whl.

File metadata

File hashes

Hashes for peerfold_review-0.1.34-py3-none-any.whl
Algorithm Hash digest
SHA256 0a91c02466147c9a4d12273a5825208156e0514b680b8de1c5534c620620255b
MD5 5da91a8a220379e5b898f348324af227
BLAKE2b-256 00b385dbaeb71827c47b13bdd8166c50756ce52bf8bb7a17e33ee67aa30c5cb3

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