peerfold-review 0.1.3__tar.gz

peerfold_review-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+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.

peerfold_review-0.1.3/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: peerfold-review
+Version: 0.1.3
+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
+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 your browser. Highlights are written as standard PDF `/Highlight` annotations — open the saved copy in Acrobat, Preview, or any PDF reader.
+
+```bash
+pipx install peerfold-review
+peerfold manuscript.pdf --reviewer VC
+```
+
+Saved reviews: `manuscript_VC-2026-06-09.pdf` next to the original.
+
+## Install
+
+| Method | Command |
+|--------|---------|
+| **pipx** (recommended) | `pipx install peerfold-review` |
+| pip | `pip install peerfold-review` |
+| Standalone binary | [GitHub Releases](https://github.com/vincenzoml/PeerFold/releases) |
+
+## Usage
+
+```bash
+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 --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
+
+```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).

peerfold_review-0.1.3/README.md

@@ -0,0 +1,49 @@
+# PeerFold
+
+Review PDFs in your browser. Highlights are written as standard PDF `/Highlight` annotations — open the saved copy in Acrobat, Preview, or any PDF reader.
+
+```bash
+pipx install peerfold-review
+peerfold manuscript.pdf --reviewer VC
+```
+
+Saved reviews: `manuscript_VC-2026-06-09.pdf` next to the original.
+
+## Install
+
+| Method | Command |
+|--------|---------|
+| **pipx** (recommended) | `pipx install peerfold-review` |
+| pip | `pip install peerfold-review` |
+| Standalone binary | [GitHub Releases](https://github.com/vincenzoml/PeerFold/releases) |
+
+## Usage
+
+```bash
+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 --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
+
+```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).

peerfold_review-0.1.3/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "peerfold-review"
+version = "0.1.3"
+description = "Local PDF review with browser UI and Acrobat-compatible highlights"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.10"
+authors = [{ name = "Vincenzo Malagola" }]
+keywords = ["pdf", "review", "annotation", "highlights", "academic"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Topic :: Text Editors :: Documentation",
+]
+dependencies = [
+    "pymupdf>=1.24.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "build>=1.2",
+    "playwright>=1.44",
+    "pyinstaller>=6.6",
+    "pytest>=8.0",
+    "twine>=5.0",
+]
+
+[project.scripts]
+peerfold = "peerfold.cli:main"
+
+[project.urls]
+Homepage = "https://vincenzoml.github.io/PeerFold/"
+Repository = "https://github.com/vincenzoml/PeerFold"
+Issues = "https://github.com/vincenzoml/PeerFold/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

peerfold_review-0.1.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

peerfold_review-0.1.3/src/peerfold/__init__.py

@@ -0,0 +1,3 @@
+"""PeerFold — local PDF review with standard highlight annotations."""
+
+__version__ = "0.1.3"

peerfold_review-0.1.3/src/peerfold/__main__.py

@@ -0,0 +1,3 @@
+from peerfold.cli import main
+
+main()

peerfold_review-0.1.3/src/peerfold/cli.py

@@ -0,0 +1,39 @@
+"""PeerFold command-line interface."""
+
+from __future__ import annotations
+
+import argparse
+import os
+from pathlib import Path
+
+from peerfold import __version__
+from peerfold.core import run_server
+
+
+def main() -> None:
+    ap = argparse.ArgumentParser(
+        prog="peerfold",
+        description="Review PDFs in the browser. Highlights are standard PDF annotations.",
+    )
+    ap.add_argument("pdf", type=Path, help="PDF to review")
+    ap.add_argument(
+        "--reviewer",
+        "-r",
+        default=os.environ.get("PEERFOLD_REVIEWER", os.environ.get("REVIEW_VIEWER", "rev")),
+        help="Short annotator name (default: $PEERFOLD_REVIEWER or 'rev')",
+    )
+    ap.add_argument("--port", type=int, default=0, help="Local port (default: ephemeral)")
+    ap.add_argument("--no-browser", action="store_true", help="Do not open a browser tab")
+    ap.add_argument("--version", action="version", version=f"peerfold {__version__}")
+    args = ap.parse_args()
+
+    run_server(
+        args.pdf,
+        reviewer=args.reviewer,
+        port=args.port,
+        open_browser=not args.no_browser,
+    )
+
+
+if __name__ == "__main__":
+    main()