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.23.tar.gz (55.5 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.23-py3-none-any.whl (53.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peerfold_review-0.1.23.tar.gz
  • Upload date:
  • Size: 55.5 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.23.tar.gz
Algorithm Hash digest
SHA256 d43992635c8d59b9ec76870b9e465515249b9d88611f217e4b3cc3a677d0ad8a
MD5 b33cf682d66a5f2e427a8ed4700ab3cb
BLAKE2b-256 86aa20aa88f64e88727aadbf44d46de1356c7d7c9d714b9dd1001a2017eb296a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peerfold_review-0.1.23-py3-none-any.whl
Algorithm Hash digest
SHA256 fca705e644e1d9ebf0a6b75b4b4cf6d423657ce3f3cef66f3bf081b1d73ebe77
MD5 a54513780f213253ae96e5356a4f6618
BLAKE2b-256 5d089723feaeff5967632351e9843c5e15faecf74c01b3922ce2412ce981405b

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