Skip to main content

Local PDF review with browser UI and Acrobat-compatible highlights

Project description

PeerFold

Review PDFs in a native window — embedded WebKit/WebView2 via pywebview, no browser tabs or URL bar. Use --browser for the system browser instead. Highlights are written as standard PDF /Highlight annotations — open the saved copy in Acrobat, Preview, or any PDF 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

Installs the latest release: macOS → Applications/PeerFold.app; Linux → ~/.local/bin/peerfold.

Windows (PowerShell)

irm https://vincenzoml.github.io/PeerFold/install.ps1 | iex

Installs to %LOCALAPPDATA%\Programs\PeerFold and adds peerfold to your user PATH.

Python 3.10+

pipx install peerfold-review
peerfold manuscript.pdf --reviewer RB

Manual downloads: GitHub Releases.

Install scripts: install.sh · install.ps1

Usage

peerfold paper.pdf                  # open browser UI
peerfold paper.pdf -r VC            # reviewer short name (filename + metadata)
peerfold paper.pdf --port 8765      # fixed port
peerfold paper.pdf --browser        # system browser instead of native window
peerfold paper.pdf --no-browser     # server only

Environment: PEERFOLD_REVIEWER sets the default reviewer name.

Features

  • Span-accurate text highlights with comment threads
  • Citation links open DOIs/URLs directly
  • Multi-tab sync, autosave, reviewer switching
  • Adobe-compatible annotation format

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.13.tar.gz (18.2 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.13-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peerfold_review-0.1.13.tar.gz
  • Upload date:
  • Size: 18.2 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.13.tar.gz
Algorithm Hash digest
SHA256 bd31b3935e569b070e0cef08b38cce3659a468b9614a362cbde9cb0159c85489
MD5 1b073ba22bfc30a087adcbb68a64a96a
BLAKE2b-256 c3950493427551d43401b53e444ddb85851deb66c1ff82769ed9647cfc0ab699

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peerfold_review-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 63b6d475bd94145f688c6814193deddefc192e7e1a4be82c9c3ecce50b378420
MD5 7e2cd5a4262b47c83e0165d054e5b02d
BLAKE2b-256 8f0ed39583e7a6269a964d4957f65859559de36d4d27b3c5f52adeb0b1761fce

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