beamerpkg 1.0.1__py3-none-any.whl

beamerpkg/__init__.py

@@ -0,0 +1,5 @@
+"""Portable Beamer presentation bundles."""
+
+from __future__ import annotations
+
+__version__ = "1.0.1"

beamerpkg/cli.py

@@ -0,0 +1,170 @@
+"""Command-line interface for beamerpkg."""
+
+from __future__ import annotations
+
+import argparse
+import json
+import shutil
+import subprocess
+import sys
+import tempfile
+from importlib.resources import files
+from pathlib import Path
+
+from .package import PackageError, extract_package, inspect_package, pack_package
+
+
+def _build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="beamerpkg",
+        description="Bundle Beamer PDFs and external media into relocatable packages.",
+    )
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    pack = subparsers.add_parser("pack", help="create a .beamerpkg container")
+    pack.add_argument("pdf", type=Path)
+    pack.add_argument("--root", type=Path, default=None, help="root for media paths")
+    pack.add_argument("--assets", type=Path, default=None, help="asset-list sidecar")
+    pack.add_argument("--output", "-o", type=Path, default=None)
+    pack.add_argument("--notes", type=Path, default=None, help="optional .pdfpc file")
+    pack.add_argument(
+        "--source-root",
+        type=Path,
+        default=None,
+        help="root used to preserve editable source paths (defaults to --root)",
+    )
+    pack.add_argument(
+        "--source",
+        type=Path,
+        action="append",
+        default=[],
+        help="editable source file or directory relative to --source-root; repeatable",
+    )
+
+    inspect = subparsers.add_parser("inspect", help="validate and describe a package")
+    inspect.add_argument("package", type=Path)
+    inspect.add_argument("--json", action="store_true", help="emit the manifest as JSON")
+
+    present = subparsers.add_parser("present", help="extract and launch with pdfpc")
+    present.add_argument("package", type=Path)
+    present.add_argument(
+        "--presenter",
+        default="pdfpc",
+        help="presenter executable (default: pdfpc)",
+    )
+
+    subparsers.add_parser(
+        "texdir",
+        help="print the directory containing beamerpkg.sty (for TEXINPUTS)",
+    )
+
+    return parser
+
+
+def _cmd_pack(args: argparse.Namespace) -> int:
+    output = pack_package(
+        args.pdf,
+        root=args.root,
+        asset_list=args.assets,
+        output=args.output,
+        notes=args.notes,
+        source_root=args.source_root,
+        sources=tuple(args.source),
+    )
+    print(output)
+    return 0
+
+
+def _cmd_inspect(args: argparse.Namespace) -> int:
+    report = inspect_package(args.package)
+    manifest = report["manifest"]
+    if args.json:
+        print(json.dumps(manifest, indent=2, sort_keys=True))
+        return 0
+
+    presentation = manifest["presentation"]
+    assets = manifest["assets"]
+    print(f"schema:       {manifest['schema_version']}")
+    print(f"presentation: {presentation['path']} ({presentation['size']} bytes)")
+    print(f"assets:       {len(assets)}")
+    if manifest.get("notes") is not None:
+        print(f"notes:        {manifest['notes']['path']}")
+    source = manifest.get("source")
+    if source is not None:
+        print(f"source files: {len(source['files'])}")
+    for asset in assets:
+        print(f"  OK  {asset['path']}  {asset['size']} bytes")
+    return 0
+
+
+def _cmd_texdir(args: argparse.Namespace) -> int:
+    print(Path(str(files("beamerpkg") / "tex")).resolve())
+    return 0
+
+
+def _cmd_present(args: argparse.Namespace) -> int:
+    package = args.package.resolve()
+    presenter = shutil.which(args.presenter)
+    if presenter is None:
+        raise PackageError(f"presenter executable not found: {args.presenter}")
+
+    with tempfile.TemporaryDirectory(prefix="beamerpkg-") as tmp:
+        destination = Path(tmp)
+        report = extract_package(package, destination)
+        presentation = report["manifest"]["presentation"]["path"]
+        completed = subprocess.run(
+            [presenter, *args.presenter_args, presentation],
+            cwd=destination,
+            check=False,
+        )
+        return completed.returncode
+
+
+def _split_presenter_args(argv: list[str]) -> tuple[list[str], list[str]]:
+    """Split arguments after -- for transparent presenter passthrough."""
+
+    if "--" not in argv:
+        return argv, []
+
+    separator = argv.index("--")
+    cli_args = argv[:separator]
+    presenter_args = argv[separator + 1 :]
+    return cli_args, presenter_args
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = _build_parser()
+    raw_argv = list(sys.argv[1:] if argv is None else argv)
+    cli_argv, explicit_presenter_args = _split_presenter_args(raw_argv)
+    args, unknown = parser.parse_known_args(cli_argv)
+
+    if args.command == "present":
+        if explicit_presenter_args and unknown:
+            parser.error(
+                "presenter arguments must be either after -- or passed directly, not both"
+            )
+        args.presenter_args = explicit_presenter_args or unknown
+    else:
+        if explicit_presenter_args:
+            parser.error("arguments after -- are only supported by the present command")
+        if unknown:
+            parser.error("unrecognized arguments: " + " ".join(unknown))
+        args.presenter_args = []
+    try:
+        if args.command == "pack":
+            return _cmd_pack(args)
+        if args.command == "inspect":
+            return _cmd_inspect(args)
+        if args.command == "present":
+            return _cmd_present(args)
+        if args.command == "texdir":
+            return _cmd_texdir(args)
+    except PackageError as exc:
+        print(f"beamerpkg: {exc}", file=sys.stderr)
+        return 2
+    parser.error(f"unknown command: {args.command}")
+    return 2
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

beamerpkg/package.py

@@ -0,0 +1,418 @@
+"""Create, validate, and extract beamerpkg containers."""
+
+from __future__ import annotations
+
+import hashlib
+import json
+import shutil
+import stat
+import tempfile
+import zipfile
+from pathlib import Path, PurePosixPath
+from typing import Any
+
+from .pdf_media import PdfMediaError, discover_pdf_media_references
+
+SCHEMA_VERSION = 1
+MANIFEST_NAME = "manifest.json"
+ASSET_LIST_SUFFIX = ".beamerpkg-assets"
+PACKAGE_SUFFIX = ".beamerpkg"
+SOURCE_PREFIX = PurePosixPath("source")
+
+
+class PackageError(ValueError):
+    """Raised when a package or requested asset is invalid."""
+
+
+def _sha256(path: Path) -> str:
+    digest = hashlib.sha256()
+    with path.open("rb") as handle:
+        for chunk in iter(lambda: handle.read(1024 * 1024), b""):
+            digest.update(chunk)
+    return digest.hexdigest()
+
+
+def _file_record(path: Path, archive_path: str) -> dict[str, Any]:
+    return {
+        "path": archive_path,
+        "size": path.stat().st_size,
+        "sha256": _sha256(path),
+    }
+
+
+def _safe_relative_path(raw: str) -> PurePosixPath:
+    normalized = raw.strip().replace("\\", "/")
+    if not normalized:
+        raise PackageError("asset path is empty")
+    if "://" in normalized or normalized.lower().startswith("file:"):
+        raise PackageError(f"remote or URI media references are unsupported: {raw!r}")
+    path = PurePosixPath(normalized)
+    if path.is_absolute() or ".." in path.parts or "." in path.parts:
+        raise PackageError(f"asset path must be a clean relative path: {raw!r}")
+    if path.parts[0].endswith(":"):
+        raise PackageError(f"asset path must not use a drive prefix: {raw!r}")
+    return path
+
+
+def read_asset_list(path: Path) -> tuple[PurePosixPath, ...]:
+    """Read one media path per line, ignoring blank lines and comments."""
+
+    if not path.is_file():
+        raise PackageError(f"asset list not found: {path}")
+
+    assets: list[PurePosixPath] = []
+    seen: set[str] = set()
+    for line_number, raw_line in enumerate(
+        path.read_text(encoding="utf-8").splitlines(), start=1
+    ):
+        stripped = raw_line.strip()
+        if not stripped or stripped.startswith("#"):
+            continue
+        try:
+            asset = _safe_relative_path(stripped)
+        except PackageError as exc:
+            raise PackageError(f"{path}:{line_number}: {exc}") from exc
+        key = asset.as_posix()
+        if key not in seen:
+            seen.add(key)
+            assets.append(asset)
+    return tuple(assets)
+
+
+def _select_asset_paths(
+    pdf: Path,
+    asset_list: Path | None,
+) -> tuple[PurePosixPath, ...]:
+    """Choose explicit sidecar assets or discover them from PDF annotations."""
+
+    if asset_list is not None:
+        resolved_asset_list = asset_list.resolve()
+        asset_paths = read_asset_list(resolved_asset_list)
+        if not asset_paths:
+            raise PackageError(
+                f"asset list contains no media paths: {resolved_asset_list}"
+            )
+        return asset_paths
+
+    try:
+        discovered = tuple(
+            _safe_relative_path(reference)
+            for reference in discover_pdf_media_references(pdf)
+        )
+    except PdfMediaError as exc:
+        raise PackageError(str(exc)) from exc
+
+    if discovered:
+        return discovered
+
+    legacy_sidecar = pdf.with_suffix(ASSET_LIST_SUFFIX)
+    if legacy_sidecar.is_file():
+        asset_paths = read_asset_list(legacy_sidecar)
+        if asset_paths:
+            return asset_paths
+
+    raise PackageError(
+        "no supported external media references found in PDF and no "
+        f"legacy asset list found at {legacy_sidecar}"
+    )
+
+
+def _collect_source_files(
+    source_root: Path,
+    source_inputs: tuple[Path, ...],
+    output: Path,
+) -> tuple[tuple[PurePosixPath, Path], ...]:
+    """Collect an explicit editable-source snapshot under the source/ prefix."""
+
+    if not source_inputs:
+        return ()
+
+    source_root = source_root.resolve()
+    if not source_root.is_dir():
+        raise PackageError(f"source root is not a directory: {source_root}")
+
+    output = output.resolve()
+    collected: dict[str, tuple[PurePosixPath, Path]] = {}
+
+    def add_file(candidate: Path) -> None:
+        if candidate.is_symlink():
+            raise PackageError(f"source symlinks are not supported: {candidate}")
+
+        resolved = candidate.resolve()
+        try:
+            relative = resolved.relative_to(source_root)
+        except ValueError as exc:
+            raise PackageError(f"source escapes source root: {candidate}") from exc
+
+        if resolved == output:
+            raise PackageError(
+                "source selection includes the output package; choose narrower "
+                f"--source inputs: {candidate}"
+            )
+
+        archive_path = SOURCE_PREFIX.joinpath(*relative.parts)
+        archive_name = archive_path.as_posix()
+        collected[archive_name] = (archive_path, resolved)
+
+    for raw_input in source_inputs:
+        if raw_input.is_absolute():
+            raise PackageError(f"source input must be relative: {raw_input}")
+
+        relative_input = _safe_relative_path(raw_input.as_posix())
+        candidate = source_root.joinpath(*relative_input.parts)
+
+        if not candidate.exists():
+            raise PackageError(f"source input not found: {raw_input}")
+        if candidate.is_symlink():
+            raise PackageError(f"source symlinks are not supported: {raw_input}")
+
+        if candidate.is_file():
+            add_file(candidate)
+            continue
+        if not candidate.is_dir():
+            raise PackageError(f"source input is not a file or directory: {raw_input}")
+
+        for child in sorted(candidate.rglob("*")):
+            if child.is_symlink():
+                raise PackageError(f"source symlinks are not supported: {child}")
+            if child.is_file():
+                add_file(child)
+
+    return tuple(collected[key] for key in sorted(collected))
+
+
+def pack_package(
+    pdf: Path,
+    *,
+    root: Path | None = None,
+    asset_list: Path | None = None,
+    output: Path | None = None,
+    notes: Path | None = None,
+    source_root: Path | None = None,
+    sources: tuple[Path, ...] = (),
+) -> Path:
+    """Bundle a PDF and its declared media files into one relocatable ZIP container."""
+
+    pdf = pdf.resolve()
+    if not pdf.is_file():
+        raise PackageError(f"presentation PDF not found: {pdf}")
+    if pdf.suffix.lower() != ".pdf":
+        raise PackageError(f"presentation must be a PDF: {pdf}")
+
+    root = (root or pdf.parent).resolve()
+    if not root.is_dir():
+        raise PackageError(f"asset root is not a directory: {root}")
+
+    output = (output or pdf.with_suffix(PACKAGE_SUFFIX)).resolve()
+    asset_paths = _select_asset_paths(pdf, asset_list)
+    resolved_source_root = (source_root or root).resolve()
+    source_files = _collect_source_files(resolved_source_root, sources, output)
+
+    reserved = {MANIFEST_NAME, pdf.name}
+    resolved_assets: list[tuple[PurePosixPath, Path]] = []
+    for archive_path in asset_paths:
+        archive_name = archive_path.as_posix()
+        if archive_name in reserved:
+            raise PackageError(f"asset path collides with package metadata: {archive_name}")
+        source = root.joinpath(*archive_path.parts).resolve()
+        try:
+            source.relative_to(root)
+        except ValueError as exc:
+            raise PackageError(f"asset escapes root: {archive_name}") from exc
+        if not source.is_file():
+            raise PackageError(f"asset not found: {archive_name} (resolved to {source})")
+        resolved_assets.append((archive_path, source))
+
+    if notes is None:
+        candidate = pdf.with_suffix(".pdfpc")
+        notes = candidate if candidate.is_file() else None
+    elif not notes.is_file():
+        raise PackageError(f"notes file not found: {notes}")
+
+    presentation_record = _file_record(pdf, pdf.name)
+    asset_records = [
+        _file_record(source, archive_path.as_posix())
+        for archive_path, source in resolved_assets
+    ]
+    notes_record = _file_record(notes, notes.name) if notes is not None else None
+    source_records = [
+        _file_record(source, archive_path.as_posix())
+        for archive_path, source in source_files
+    ]
+    source_record = (
+        {"root": SOURCE_PREFIX.as_posix(), "files": source_records}
+        if source_records
+        else None
+    )
+
+    manifest = {
+        "schema_version": SCHEMA_VERSION,
+        "presentation": presentation_record,
+        "notes": notes_record,
+        "assets": asset_records,
+        "source": source_record,
+    }
+
+    output.parent.mkdir(parents=True, exist_ok=True)
+    with tempfile.NamedTemporaryFile(
+        prefix=f".{output.name}.", suffix=".tmp", dir=output.parent, delete=False
+    ) as handle:
+        temporary_output = Path(handle.name)
+
+    try:
+        # Media and PDFs are already compressed. ZIP_STORED keeps packaging fast and
+        # preserves media bytes exactly rather than spending CPU for negligible gain.
+        with zipfile.ZipFile(temporary_output, "w", compression=zipfile.ZIP_STORED) as zf:
+            zf.writestr(
+                MANIFEST_NAME,
+                json.dumps(manifest, indent=2, sort_keys=True) + "\n",
+            )
+            zf.write(pdf, arcname=pdf.name)
+            if notes is not None:
+                zf.write(notes, arcname=notes.name)
+            for archive_path, source in resolved_assets:
+                zf.write(source, arcname=archive_path.as_posix())
+            for archive_path, source in source_files:
+                zf.write(source, arcname=archive_path.as_posix())
+        temporary_output.replace(output)
+    except Exception:
+        temporary_output.unlink(missing_ok=True)
+        raise
+
+    return output
+
+
+def _load_manifest(zf: zipfile.ZipFile) -> dict[str, Any]:
+    try:
+        raw = zf.read(MANIFEST_NAME)
+    except KeyError as exc:
+        raise PackageError(f"package is missing {MANIFEST_NAME}") from exc
+    try:
+        manifest = json.loads(raw.decode("utf-8"))
+    except (UnicodeDecodeError, json.JSONDecodeError) as exc:
+        raise PackageError("manifest.json is not valid UTF-8 JSON") from exc
+    if not isinstance(manifest, dict):
+        raise PackageError("manifest.json must contain a JSON object")
+    if manifest.get("schema_version") != SCHEMA_VERSION:
+        raise PackageError(
+            "unsupported schema_version: " f"{manifest.get('schema_version')!r}"
+        )
+    return manifest
+
+
+def _manifest_records(manifest: dict[str, Any]) -> tuple[dict[str, Any], ...]:
+    presentation = manifest.get("presentation")
+    if not isinstance(presentation, dict):
+        raise PackageError("manifest.presentation must be an object")
+    assets = manifest.get("assets")
+    if not isinstance(assets, list):
+        raise PackageError("manifest.assets must be a list")
+    notes = manifest.get("notes")
+    source = manifest.get("source")
+
+    records: list[dict[str, Any]] = [presentation]
+    if notes is not None:
+        if not isinstance(notes, dict):
+            raise PackageError("manifest.notes must be an object or null")
+        records.append(notes)
+    for asset in assets:
+        if not isinstance(asset, dict):
+            raise PackageError("manifest asset entries must be objects")
+        records.append(asset)
+
+    if source is not None:
+        if not isinstance(source, dict):
+            raise PackageError("manifest.source must be an object or null")
+        if source.get("root") != SOURCE_PREFIX.as_posix():
+            raise PackageError("manifest.source.root must be 'source'")
+        source_files = source.get("files")
+        if not isinstance(source_files, list):
+            raise PackageError("manifest.source.files must be a list")
+        for source_file in source_files:
+            if not isinstance(source_file, dict):
+                raise PackageError("manifest source entries must be objects")
+            source_path = source_file.get("path")
+            if not isinstance(source_path, str):
+                raise PackageError("manifest source entry is missing string path")
+            safe_source_path = _safe_relative_path(source_path)
+            if not safe_source_path.parts or safe_source_path.parts[0] != "source":
+                raise PackageError("manifest source paths must be under source/")
+            records.append(source_file)
+
+    return tuple(records)
+
+
+def inspect_package(package: Path) -> dict[str, Any]:
+    """Validate a package and return its manifest plus an ``ok`` marker."""
+
+    package = package.resolve()
+    if not package.is_file():
+        raise PackageError(f"package not found: {package}")
+
+    try:
+        with zipfile.ZipFile(package, "r") as zf:
+            manifest = _load_manifest(zf)
+            names = zf.namelist()
+            if len(names) != len(set(names)):
+                raise PackageError("package contains duplicate ZIP member names")
+
+            records = _manifest_records(manifest)
+            expected = {MANIFEST_NAME}
+            for record in records:
+                archive_path = record.get("path")
+                if not isinstance(archive_path, str):
+                    raise PackageError("manifest file record is missing string path")
+                safe_path = _safe_relative_path(archive_path).as_posix()
+                expected.add(safe_path)
+                try:
+                    payload = zf.read(safe_path)
+                except KeyError as exc:
+                    raise PackageError(f"package is missing declared file: {safe_path}") from exc
+                if record.get("size") != len(payload):
+                    raise PackageError(f"size mismatch for {safe_path}")
+                digest = hashlib.sha256(payload).hexdigest()
+                if record.get("sha256") != digest:
+                    raise PackageError(f"SHA-256 mismatch for {safe_path}")
+
+            unexpected = set(names) - expected
+            if unexpected:
+                raise PackageError(
+                    "package contains undeclared files: " + ", ".join(sorted(unexpected))
+                )
+
+            presentation_path = manifest["presentation"]["path"]
+            if not zf.read(presentation_path).startswith(b"%PDF-"):
+                raise PackageError("declared presentation does not look like a PDF")
+    except zipfile.BadZipFile as exc:
+        raise PackageError(f"not a valid ZIP package: {package}") from exc
+
+    return {"ok": True, "manifest": manifest}
+
+
+def _is_zip_symlink(info: zipfile.ZipInfo) -> bool:
+    mode = info.external_attr >> 16
+    return stat.S_ISLNK(mode)
+
+
+def extract_package(package: Path, destination: Path) -> dict[str, Any]:
+    """Validate and safely extract a package into an existing directory."""
+
+    report = inspect_package(package)
+    destination = destination.resolve()
+    destination.mkdir(parents=True, exist_ok=True)
+
+    with zipfile.ZipFile(package, "r") as zf:
+        for info in zf.infolist():
+            if _is_zip_symlink(info):
+                raise PackageError(f"ZIP symlink entries are not allowed: {info.filename}")
+            archive_path = _safe_relative_path(info.filename)
+            target = destination.joinpath(*archive_path.parts).resolve()
+            try:
+                target.relative_to(destination)
+            except ValueError as exc:
+                raise PackageError(f"ZIP member escapes destination: {info.filename}") from exc
+            target.parent.mkdir(parents=True, exist_ok=True)
+            with zf.open(info, "r") as source, target.open("wb") as sink:
+                shutil.copyfileobj(source, sink)
+
+    return report

beamerpkg/pdf_media.py

@@ -0,0 +1,94 @@
+"""Discover external media references from PDF annotations."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any
+
+from pypdf import PdfReader
+
+
+class PdfMediaError(ValueError):
+    """Raised when PDF media annotations cannot be inspected."""
+
+
+def _resolve(value: Any) -> Any:
+    get_object = getattr(value, "get_object", None)
+    return get_object() if callable(get_object) else value
+
+
+def _file_spec_text(value: Any) -> str | None:
+    value = _resolve(value)
+    if isinstance(value, str):
+        return value
+    if isinstance(value, dict):
+        for key in ("/UF", "/F"):
+            candidate = _resolve(value.get(key))
+            if isinstance(candidate, str):
+                return candidate
+    return None
+
+
+def _pdfpc_launch_media_reference(raw: str) -> str | None:
+    """Return a media path from a recognized pdfpc launch-link target."""
+
+    reference, separator, query = raw.strip().partition("?")
+    if not separator:
+        return None
+
+    option_names = {
+        part.split("=", 1)[0].strip().lower()
+        for part in query.split("&")
+        if part.strip()
+    }
+    if not option_names.intersection({"autostart", "loop", "start", "stop"}):
+        return None
+    return reference
+
+
+def discover_pdf_media_references(pdf: Path) -> tuple[str, ...]:
+    """Return external media paths referenced by supported PDF annotations.
+
+    Supports standard /Movie annotations emitted by Beamer's multimedia package
+    and pdfpc-style /Launch links carrying recognized media options such as
+    autostart or loop.
+    """
+
+    try:
+        reader = PdfReader(str(pdf), strict=False)
+    except Exception as exc:
+        raise PdfMediaError(f"failed to read PDF annotations from {pdf}: {exc}") from exc
+
+    references: list[str] = []
+    seen: set[str] = set()
+
+    for page in reader.pages:
+        annotations = _resolve(page.get("/Annots")) or []
+        for annotation_ref in annotations:
+            annotation = _resolve(annotation_ref)
+            if not isinstance(annotation, dict):
+                continue
+
+            reference: str | None = None
+            subtype = annotation.get("/Subtype")
+
+            if subtype == "/Movie":
+                movie = _resolve(annotation.get("/Movie"))
+                if isinstance(movie, dict):
+                    reference = _file_spec_text(movie.get("/F"))
+            elif subtype == "/Link":
+                action = _resolve(annotation.get("/A"))
+                if isinstance(action, dict) and action.get("/S") == "/Launch":
+                    raw = _file_spec_text(action.get("/F"))
+                    if raw is not None:
+                        reference = _pdfpc_launch_media_reference(raw)
+
+            if reference is None:
+                continue
+
+            key = reference.strip()
+            if key and key not in seen:
+                seen.add(key)
+                references.append(key)
+
+    return tuple(references)

beamerpkg/tex/beamerpkg.sty

@@ -0,0 +1,29 @@
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{beamerpkg}[2026/09/30 v0.2 Record Beamer movie assets]
+
+\RequirePackage{multimedia}
+\RequirePackage{hyperref}
+
+\newwrite\beamerpkgassetfile
+\immediate\openout\beamerpkgassetfile=\jobname.beamerpkg-assets
+\AtEndDocument{\immediate\closeout\beamerpkgassetfile}
+
+\newcommand{\beamerpkgrecordasset}[1]{%
+  \begingroup
+  \edef\beamerpkgassetpath{\detokenize{#1}}%
+  \immediate\write\beamerpkgassetfile{\beamerpkgassetpath}%
+  \endgroup
+}
+
+% Portable standard Beamer movie annotation. In pdfpc this is click-to-play.
+\newcommand{\pkgmovie}[3][]{%
+  \beamerpkgrecordasset{#3}%
+  \movie[#1]{#2}{#3}%
+}
+
+% pdfpc-specific launch-link movie. Options follow pdfpc's run: URL syntax,
+% e.g. [autostart&loop]. Keep this separate from the portable \movie path.
+\newcommand{\pkgpdfpcmovie}[3][autostart]{%
+  \beamerpkgrecordasset{#3}%
+  \href{run:#3?#1}{#2}%
+}

beamerpkg-1.0.1.dist-info/METADATA

@@ -0,0 +1,281 @@
+Metadata-Version: 2.4
+Name: beamerpkg
+Version: 1.0.1
+Summary: Portable Beamer/PDF presentation bundles with external media assets
+License-Expression: Apache-2.0
+License-File: LICENSE
+Author: Uli Kerzel
+Requires-Python: >=3.11,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Dist: pypdf (>=5.0,<7.0)
+Project-URL: Homepage, https://github.com/ukerzel/beamerpkg
+Project-URL: Issues, https://github.com/ukerzel/beamerpkg/issues
+Project-URL: Repository, https://github.com/ukerzel/beamerpkg
+Description-Content-Type: text/markdown
+
+# beamerpkg
+
+`beamerpkg` makes multimedia Beamer presentations portable without replacing
+Beamer's rendering model.
+
+```text
+Beamer -> ordinary PDF + external MP4 files -> one relocatable .beamerpkg
+                                               |
+                                               v
+                                   unpack temporarily + pdfpc
+```
+
+Equations, TikZ, columns, backgrounds, arrows, Beamer overlays, fonts, and all
+other slide layout remain PDF. The package layer only restores external media at
+the relative paths already referenced by the PDF.
+
+## Status
+
+The container/path MVP was validated on **2026-09-30** with pdfpc under WSL/WSLg:
+the packaged PDF rendered normally and the packaged H.264 video played in the
+TeX-defined rectangle. The full-resolution autoplay demo also works.
+
+Version 0.2 adds **wrapperless media discovery**: for standard Beamer
+`multimedia/\movie` documents, `beamerpkg pack` reads the PDF annotation and
+collects the referenced local media automatically. A `.beamerpkg-assets`
+sidecar is no longer required for normal use.
+
+## Package format
+
+A `.beamerpkg` is an ordinary ZIP archive:
+
+```text
+talk.beamerpkg
+├── manifest.json
+├── talk.pdf
+├── talk.pdfpc          # optional
+├── media/
+│   └── simulation.mp4
+└── source/             # optional editable source snapshot
+    ├── talk.tex
+    ├── figures/
+    └── references.bib
+```
+
+The manifest contains SHA-256 hashes and byte sizes. Runtime media are stored at
+exactly the same relative paths used by Beamer. Optional editable sources live
+under `source/` and are recorded separately in the manifest.
+
+## Install for development
+
+Requires Python 3.11+ and Poetry.
+
+```bash
+poetry install
+```
+
+The only runtime Python dependency is `pypdf`, used to inspect PDF annotations.
+
+## Optional editable source payload
+
+A presentation package can also carry the LaTeX source and authoring assets so
+the recipient can modify and rebuild the presentation without editing the PDF.
+
+Source inclusion is explicit. Pass a source root and repeat `--source` for the
+files or directories to preserve:
+
+```bash
+poetry run beamerpkg pack build/talk.pdf \
+  --root build \
+  --source-root . \
+  --source talk.tex \
+  --source figures \
+  --source references.bib
+```
+
+Those files are stored with their relative structure under `source/`:
+
+```text
+source/
+├── talk.tex
+├── figures/
+│   └── plot.png
+└── references.bib
+```
+
+Because `.beamerpkg` is an ordinary ZIP archive, a recipient can unpack it,
+edit the source tree, and rebuild with their normal LaTeX toolchain. Runtime
+presentation files remain separate, so including sources never changes pdfpc
+playback.
+
+The source snapshot is deliberately opt-in and explicit: beamerpkg does not
+guess which files constitute a reproducible authoring project. Directories are
+included recursively; source paths must remain within `--source-root`, and
+symlinks are rejected.
+
+An asset needed both by the runtime presentation and by the editable source tree
+may be stored twice. This keeps both trees self-contained and avoids symlink or
+viewer-specific deduplication behavior in the package format.
+
+## Standard Beamer: no Beamerpkg LaTeX helper required
+
+The wrapperless standard-Beamer route is **click-to-start in pdfpc**. This is
+the expected behavior of the normal `\movie` annotation path; autoplay is a
+separate pdfpc-specific feature described below.
+
+Write an ordinary Beamer movie:
+
+```latex
+\usepackage{multimedia}
+
+\movie[loop,showcontrols]
+  {\includegraphics[width=\linewidth]{media/poster.png}}
+  {media/video.mp4}
+```
+
+Compile it normally, then package it:
+
+```bash
+poetry run beamerpkg pack talk.pdf --root .
+```
+
+The packer discovers the external `/Movie` file reference from the PDF,
+validates that it is a safe local relative path, and includes it at the same path
+inside the container.
+
+An explicit sidecar remains available as a compatibility/fallback route:
+
+```bash
+poetry run beamerpkg pack talk.pdf --root . --assets talk.beamerpkg-assets
+```
+
+## pdfpc autoplay
+
+Autoplay is viewer-specific rather than part of the container format. For pdfpc,
+the bundled LaTeX helper `beamerpkg.sty` provides:
+
+```latex
+\pkgpdfpcmovie[autostart&loop]
+  {\includegraphics[width=\linewidth]{media/poster.png}}
+  {media/video.mp4}
+```
+
+The helper ships with the Python package. `beamerpkg texdir` prints its
+directory, so LaTeX can find it without copying files:
+
+```bash
+TEXINPUTS="$(beamerpkg texdir)//:" pdflatex talk.tex
+```
+
+In a repository checkout it lives at `src/beamerpkg/tex/beamerpkg.sty`.
+
+This emits pdfpc's `run:` launch-link mechanism. The packer also recognizes
+these pdfpc media launch links and strips their query options when collecting
+the underlying media file.
+
+## pdfpc speaker notes and settings
+
+If a same-name pdfpc sidecar exists beside the PDF, it is included automatically:
+
+```text
+talk.pdf
+talk.pdfpc
+```
+
+```bash
+poetry run beamerpkg pack talk.pdf --root .
+```
+
+The resulting package records `talk.pdfpc` separately as `notes` in the
+manifest and restores it beside `talk.pdf` before launching pdfpc. This keeps
+speaker notes and other pdfpc presentation metadata portable without putting
+them into the PDF itself.
+
+The repository demo contains `examples/demo.pdfpc` with a visible speaker note
+on the first page so this behavior can be checked in presenter view.
+
+## Inspect and present
+
+```bash
+poetry run beamerpkg inspect talk.beamerpkg
+poetry run beamerpkg present talk.beamerpkg
+```
+
+`beamerpkg present` validates the archive, extracts it to a temporary directory
+while preserving all relative paths, launches `pdfpc` from that directory, and
+keeps the directory alive until the presenter exits. Arguments after `--` are
+forwarded verbatim to the presenter before the PDF filename.
+
+For a single physical monitor, keep both pdfpc windows available and switch
+between presenter and audience views with the desktop window switcher.
+
+When invoking through Poetry, pass pdfpc options directly after the package:
+
+```bash
+poetry run beamerpkg present talk.beamerpkg -w both
+```
+
+Poetry may consume a literal `--` separator before the Beamerpkg CLI sees it.
+When invoking an installed `beamerpkg` executable directly, the explicit
+separator form is also supported:
+
+```bash
+beamerpkg present talk.beamerpkg -- -w both
+```
+
+This is intentionally transparent passthrough rather than a Beamerpkg-specific
+single-monitor mode. Other pdfpc options work the same way.
+
+## Demo
+
+The demo uses the full repository assets, a pdfpc metadata sidecar, and an
+editable source snapshot:
+
+- `examples/media/gemini_generated_video_b2693757.mp4`
+- `examples/media/video-poster_big.png`
+- `examples/demo.pdfpc` (speaker notes / pdfpc metadata)
+- `source/examples/demo.tex`
+- `source/examples/media/...`
+- `source/src/beamerpkg/tex/beamerpkg.sty`
+
+The mixed demo also contains two lightweight Beamer/PDF motion examples before
+the video slides:
+
+- a short `\transfade[duration=0.2]` page transition;
+- a three-state manual overlay sequence that progressively builds
+  `Input -> Model -> Result` and remains fully reversible with the arrow keys.
+
+Both are encoded in the PDF itself; `beamerpkg` does not need to discover or
+package anything special for them. The overlay example deliberately avoids
+`\transduration`: timed PDF pages restart their timer when revisited, which
+makes backward navigation jump forward again.
+
+Build both the mixed autoplay demo and a pure stock-Beamer wrapperless example:
+
+```bash
+git pull --rebase
+poetry install
+./examples/build_demo.sh
+
+poetry run beamerpkg present examples/demo.beamerpkg
+poetry run beamerpkg present examples/wrapperless.beamerpkg
+```
+
+`examples/demo.tex` also embeds speaker notes and a 10-minute countdown via
+the standard `pdfpc` LaTeX package, so they travel inside the PDF itself. The
+title page deliberately has no embedded note: pdfpc lets an embedded note
+replace the sidecar note for the same page, so page 1 keeps showing the
+`examples/demo.pdfpc` note and both routes can be checked in presenter view.
+
+`examples/wrapperless.tex` imports only Beamer's `multimedia` package. It is
+the integration proof that packaging no longer depends on a Beamerpkg-specific
+LaTeX command. In pdfpc this wrapperless example is click-to-start.
+
+The mixed `examples/demo.tex` intentionally contains two video slides: one
+standard wrapperless `\movie` slide that is click-to-start, followed by one
+pdfpc-specific `\pkgpdfpcmovie[autostart&loop]` slide that starts
+automatically.
+
+See [`docs/MVP.md`](https://github.com/ukerzel/beamerpkg/blob/main/docs/MVP.md) for the original acceptance test and
+[`docs/NEXT_STEPS.md`](https://github.com/ukerzel/beamerpkg/blob/main/docs/NEXT_STEPS.md) for the remaining work.
+

beamerpkg-1.0.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+beamerpkg/__init__.py,sha256=b6_q-0y4c9sS_OZcc_gi0pBgQ30BRSWEmBmM6BkyXKU,103
+beamerpkg/cli.py,sha256=xNcjI5BGlvHdiUQFfjU9pL-9EvWHasrDmKIJ7xdPDK0,5638
+beamerpkg/package.py,sha256=0NbpPhyAMWU1Lbezkvuzkmr7efTZQWscyfLkiND6ezg,15574
+beamerpkg/pdf_media.py,sha256=KmsLBWDBuI_Nyy3DSq1kWxk358xnFG_nyQYlgMjdXxw,2953
+beamerpkg/tex/beamerpkg.sty,sha256=UyLBia8xMhPhVL6FbJAJOQprUz9juSUnPnzDmsDlCJo,887
+beamerpkg-1.0.1.dist-info/METADATA,sha256=LRQba46dNzX-GHbuNR3RkOhuq4TcPYtHjt0fFthllZw,9585
+beamerpkg-1.0.1.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
+beamerpkg-1.0.1.dist-info/entry_points.txt,sha256=pD-TX3Jbw0KzyYom8F4ZCe3htHt1jixxL9XQ1kvUjXM,48
+beamerpkg-1.0.1.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+beamerpkg-1.0.1.dist-info/RECORD,,

beamerpkg-1.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.5.0
+Root-Is-Purelib: true
+Tag: py3-none-any

beamerpkg-1.0.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+beamerpkg=beamerpkg.cli:main
+

beamerpkg-1.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS