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

curl -fsSL https://vincenzoml.github.io/PeerFold/peerfold.py -o peerfold.py && chmod +x peerfold.py
./peerfold.py your-paper.pdf --reviewer AB

Or download peerfold.py into your project root. Packages are cached in ~/.local/share/peerfold/cache (uv; override with PEERFOLD_CACHE / PEERFOLD_DATA).

Upgrade when needed:

./peerfold.py --update   # then commit 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.36.tar.gz (127.8 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.36-py3-none-any.whl (127.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peerfold_review-0.1.36.tar.gz
  • Upload date:
  • Size: 127.8 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.36.tar.gz
Algorithm Hash digest
SHA256 67291d4222c250a8325bb68fd699d4c955728d54f378e8155d475e60e293b1ad
MD5 4f3a1715eb145be3c1b924ed7f1cc661
BLAKE2b-256 2bbb0555847884147de3bb67c6c47b8650da4397ac4a1a2584018d77e253788f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peerfold_review-0.1.36-py3-none-any.whl
Algorithm Hash digest
SHA256 64cd11b3a730346b9071e9d7e3294018ecae5a7137ff08faec63a769b2180922
MD5 a56c39da5a6e75d07a2c2c40730c57cf
BLAKE2b-256 f12d51700dcff1369e6983226ba04e09c0ac6241a8c5c8f9d34941e9812dd780

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