Skip to main content

Local PDF review with browser UI and Acrobat-compatible highlights

Project description

PeerFold

Website: vincenzoml.github.io/PeerFold · Source: github.com/vincenzoml/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.37.tar.gz (129.3 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.37-py3-none-any.whl (128.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peerfold_review-0.1.37.tar.gz
  • Upload date:
  • Size: 129.3 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.37.tar.gz
Algorithm Hash digest
SHA256 7190683022ee299fc33eedc70a43c1af1fcdd9b296d76309bab8d8c11c6fdf8a
MD5 48058bd58215d3b19cd4ac8f72a741d3
BLAKE2b-256 708a456f06795c167770afd7ff7996c9d23cec4f87d2291e512c5e3c9added9b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peerfold_review-0.1.37-py3-none-any.whl
Algorithm Hash digest
SHA256 00f0711728a1dfc5369796e1f89c3ae280e9a5d513ca31e599c37d39ff9e6814
MD5 e451851ae6d634f9194aa1009e7234d7
BLAKE2b-256 4dfa869a2a721682b61f9f98c2bf8fe841ec91b5ad0e5f7139e2d0183e9d9337

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