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.30.tar.gz (119.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.30-py3-none-any.whl (120.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peerfold_review-0.1.30.tar.gz
  • Upload date:
  • Size: 119.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.30.tar.gz
Algorithm Hash digest
SHA256 adc5fb9999d049b882ec5ae4dbca1e631d3cddfef19efa5111b55d391a9bafb3
MD5 94e6c6d7d7e2d34b23c69fcd7af99b12
BLAKE2b-256 affc518ee82d07a073e886126f8acd225d6582719a86440cf732958164186459

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peerfold_review-0.1.30-py3-none-any.whl
Algorithm Hash digest
SHA256 cbc4a94f8843fef7869f8203803410d2e6beb0069f1bc171c69f8d6eaaeaad4a
MD5 3a4303d1ad2de5233ea0b667c13d2130
BLAKE2b-256 e7b92bd1edb734d1e297c2b927a480483e47743275606493260ea0940c43fd30

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