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.26.tar.gz (55.9 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.26-py3-none-any.whl (53.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peerfold_review-0.1.26.tar.gz
  • Upload date:
  • Size: 55.9 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.26.tar.gz
Algorithm Hash digest
SHA256 770cb7fc794772b2a61b9798c8f628891efc8f01e0501b49a19c3237137141a8
MD5 4d8529d86fd977bb3da139aaefd53b6d
BLAKE2b-256 847da6e79c48d3ea132bfe5a811362efe57b4258c5448c017ca9fd52050c796c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peerfold_review-0.1.26-py3-none-any.whl
Algorithm Hash digest
SHA256 aa75e69f6d268ec1657cd20ea50fda8622fe356e66a64139cf22c6397246550b
MD5 0248584a00aedcea9f0c03e4343deec4
BLAKE2b-256 b7f88f84b03533a264131d67d914f9681c0b038d3ddc4135ddd58514e681c13b

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