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.35.tar.gz (124.0 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.35-py3-none-any.whl (124.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peerfold_review-0.1.35.tar.gz
  • Upload date:
  • Size: 124.0 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.35.tar.gz
Algorithm Hash digest
SHA256 c82938381916f73cd749f5a2b02e02d7fc55687107768cd8f83bc1984b6ce28a
MD5 a863a3ee24c4d5bb7ef94d1de0599ff8
BLAKE2b-256 270f40a75598ed734f5e6829e11e9cc24741813d789e8abe5b6986b7881687a3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peerfold_review-0.1.35-py3-none-any.whl
Algorithm Hash digest
SHA256 84d2b2946ba99d60b563ae990f251d830b84008920c650cf31ddd52a101a04c2
MD5 30b29787d1f96f2272ec4681c40b9226
BLAKE2b-256 02830d079400ae694ad27aace22fd42bb2f9addf69805d89490d2f860ff2cfdb

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