beamerpkg 1.0.1__tar.gz

beamerpkg-1.0.1/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

beamerpkg-1.0.1/PKG-INFO

@@ -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.
+