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.py → scripts/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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file peerfold_review-0.1.20.tar.gz.
File metadata
- Download URL: peerfold_review-0.1.20.tar.gz
- Upload date:
- Size: 53.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9bcccbfab8575ed62553eba4c664829addcaa0bbe2bb792fb315e4ac7bf0955f
|
|
| MD5 |
10ae9380975e9010b6f23554a82de070
|
|
| BLAKE2b-256 |
ceea77c6944ffe2093335dee52ed34087d9a3182b39785904c6244865cee7f7d
|
File details
Details for the file peerfold_review-0.1.20-py3-none-any.whl.
File metadata
- Download URL: peerfold_review-0.1.20-py3-none-any.whl
- Upload date:
- Size: 51.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
944ca73b96f4d86a6793cc50ee241ba12c56a72be7d6a08d1e5d2d6a164c826b
|
|
| MD5 |
db7712bbe6760be84eecd038879c9412
|
|
| BLAKE2b-256 |
c2d45382df27a381fffcc6191cc23dc60f38e739fd5ed0b44640750c1609084b
|