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.14.tar.gz (19.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.14-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peerfold_review-0.1.14.tar.gz
  • Upload date:
  • Size: 19.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.14.tar.gz
Algorithm Hash digest
SHA256 e993920fe6c9cec9f5451294dd47b8d7a7acf6efcf26875ae1271fd26844da5b
MD5 1be3e9c54fa5b93c84faacd7232308d0
BLAKE2b-256 b5f32500ed00fe3033dc4ebf87269e736a019c19cc8efb9b007ffe4b1b8f1ff0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peerfold_review-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 de9fde25a1a87a758285eefcb7264b65e06fdde112cdde141fefcefa45c7d659
MD5 c1aa1ef81d974a5bcdfac4f4f1dea90c
BLAKE2b-256 93b2177b2be90b0d0c2d1e3fa1d9bfb872dba185e53e989953747945094e1111

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