Metadata-Version: 2.4
Name: peerfold-review
Version: 0.1.25
Summary: Local PDF review with browser UI and Acrobat-compatible highlights
Author: Vincenzo Malagola
License: MIT License
        
        Copyright (c) 2026 Vincenzo Malagola
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://vincenzoml.github.io/PeerFold/
Project-URL: Repository, https://github.com/vincenzoml/PeerFold
Project-URL: Issues, https://github.com/vincenzoml/PeerFold/issues
Keywords: pdf,review,annotation,highlights,academic
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Editors :: Documentation
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pymupdf>=1.24.0
Requires-Dist: pywebview>=5.3
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: playwright>=1.44; extra == "dev"
Requires-Dist: pyinstaller>=6.6; extra == "dev"
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: twine>=5.0; extra == "dev"
Dynamic: license-file

# 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**

```bash
curl -fsSL https://vincenzoml.github.io/PeerFold/install.sh | bash
```

**Windows** (PowerShell)

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

**Python 3.10+**

```bash
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):

```bash
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](https://vincenzoml.github.io/PeerFold/peerfold.py) → `scripts/peerfold.py`, add `.venv-peerfold/` to `.gitignore`.

Upgrade when needed:

```bash
python3 scripts/peerfold.py --update   # then commit scripts/peerfold.py
```

Site: [vincenzoml.github.io/PeerFold](https://vincenzoml.github.io/PeerFold/)

## Usage

```bash
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

```bash
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
peerfold sample.pdf
pytest
```

## License

MIT — see [LICENSE](LICENSE). Uses [PyMuPDF](https://pymupdf.readthedocs.io/) (AGPL).
