paperkit 0.1.0__py3-none-any.whl

paperkit-0.1.0.dist-info/METADATA

@@ -0,0 +1,381 @@
+Metadata-Version: 2.5
+Name: paperkit
+Version: 0.1.0
+Summary: Reproducible builds and pre-submission checks for research papers
+Project-URL: Homepage, https://github.com/apaolillo/paperkit
+Project-URL: Repository, https://github.com/apaolillo/paperkit
+Project-URL: Issues, https://github.com/apaolillo/paperkit/issues
+Project-URL: Changelog, https://github.com/apaolillo/paperkit/blob/main/CHANGELOG.md
+Author-email: Antonio Paolillo <antonio.paolillo@vub.be>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: camera-ready,docker,latex,paper,reproducible-builds,texlive
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Requires-Python: >=3.12
+Requires-Dist: click>=8
+Requires-Dist: pythainer>=0.0.7
+Description-Content-Type: text/markdown
+
+# paperkit
+
+Reproducible builds and pre-submission checks for research papers. paperkit
+builds your paper in a container composed from a config file, then checks it
+for the problems that get submissions desk-rejected or camera-ready PDFs
+bounced: page limits, Type 3 or unembedded fonts, LaTeX errors, overfull
+boxes, unused bibliography entries. It currently supports LaTeX; Typst is on
+the [roadmap](ROADMAP.md).
+
+## Features
+
+- **Container builds**: reproducible builds in Docker via
+  [pythainer](https://github.com/apaolillo/pythainer), with every engine
+  (pdflatex, lualatex, xelatex) and bibliography tool (bibtex, biber)
+  installed, or builds on the host.
+- **Pinned TeX Live**: optionally install TeX Live from a dated snapshot, so
+  every image rebuild gets the same package set.
+- **Page limits**: report total pages and pages before references and
+  acknowledgments, and flag a paper over its configured limits.
+- **Pre-submission checks**: LaTeX and bibliography log errors, overfull
+  boxes, font embedding and Type 3 fonts, non-ASCII characters, trailing
+  whitespace, final newlines, unused bibliography entries, bibtex-tidy.
+- **Several targets per project**: build a paper and its companion documents
+  in parallel, or just one of them; bibliography checks look at every target
+  sharing a bib file.
+- **Submission plumbing**: a source archive with configurable include and
+  exclude patterns, and the title and abstract exported as plain text for
+  pasting into submission forms.
+- **Profiles**: defaults per publisher (base and ACM so far).
+
+## Installation
+
+Requires Python 3.12+ and, for container builds, Docker.
+
+```bash
+pip install paperkit
+# or, as an isolated command-line tool:
+uv tool install paperkit
+```
+
+## Quick start
+
+```bash
+# Generate a config file
+paperkit init
+
+# Build the paper (in Docker by default)
+paperkit build
+
+# Build on host (no Docker)
+paperkit build --no-docker
+
+# Run checks only (on existing build output, in Docker by default)
+paperkit check
+
+# Tidy the bibliography (add --no-sort to keep the entry order)
+paperkit bibtidy
+
+# Create submission archive
+paperkit zip
+```
+
+## Configuration
+
+paperkit looks for `.paperkit.toml` in the current directory or any parent. Example:
+
+```toml
+[project]
+main = "paper"
+content_dirs = ["content"]
+bib = "references.bib"
+
+[build]
+engine = "pdflatex"         # pdflatex | lualatex | xelatex
+passes = 3                  # 4th pass enables pbalance
+shell_escape = true
+bibtex = true               # use bibtex after pass 1
+biber = false               # use biber instead of bibtex
+output_dir = "out"
+source_date_epoch = "git"   # timestamp builds are pinned to; see below
+
+[docker]
+base_image = "ubuntu:26.04"
+image_name = "paper-builder"
+extra_packages = []         # additional APT packages
+
+[checks]
+non_ascii = true
+trailing_whitespace = true
+final_newline = true
+unused_bib = true
+font_embedding = true       # requires poppler-utils
+no_type3 = true             # warn on Type 3 (bitmap) fonts (part of font_embedding)
+                            # full listing + Type 3 pages: out/<main>/fonts.txt
+overfull_boxes = true
+bibtex_tidy = { enabled = true, version = "1.14.0", sort = true }
+
+[page_limits]                    # optional; without it the pages are only reported
+total = 14                       # max pages, references included
+before_refs = 14                 # max pages of content before the references
+before_ack = 13                  # max pages of content before the acknowledgments
+ack_counts_as_content = false    # see below
+
+[zip]
+name = "paper"
+include = [
+    "{main}.tex",
+    "content/*.tex",
+    "content/references.bib",
+]
+exclude = ["*.aux", "*.log", "*.out", "*.blg", "*.bbl"]
+include_bbl = false         # also ship each main's compiled bibliography
+
+[profile]
+name = "base"               # base | acm
+```
+
+## Commands
+
+| Command | Description |
+|---|---|
+| `paperkit build [NAMES]` | Build the paper PDFs (Docker by default) |
+| `paperkit build --no-docker` | Build directly on the host |
+| `paperkit shell` | Open an interactive shell in the Docker container |
+| `paperkit check [NAMES]` | Run checks on existing build output (Docker by default) |
+| `paperkit check --no-docker` | Run checks with the host's tools |
+| `paperkit bibtidy` | Run bibtex-tidy on the bib file (in-place); `--no-sort` keeps the entry and field order |
+| `paperkit zip` | Create submission archive; `--bbl` adds the compiled bibliographies |
+| `paperkit init` | Generate a `.paperkit.toml` template (`--texlive distro` for the base image's packages) |
+| `paperkit texlive-update` | Move `[texlive]` to the newest dated snapshot (`--check` to only report) |
+
+Global options: `--config PATH` (config file), `-v/--verbose` (show Docker commands), `-V/--version`.
+
+## Checks
+
+| Check | What it does |
+|---|---|
+| LaTeX log | Parse `.log` for errors and warnings |
+| BibTeX/Biber log | Parse `.blg` for errors and warnings |
+| Boxes | Count overfull and underfull boxes |
+| Toolchain | With `[texlive] source = "upstream"`: warn if the log shows the PDF was built with another TeX Live (e.g. the host's, via `--no-docker`) |
+| Fonts | Verify all fonts are embedded (`pdffonts`) |
+| Non-ASCII | Flag non-ASCII characters in `.tex` source |
+| Trailing whitespace | Detect lines with trailing spaces |
+| Final newline | Ensure each file ends with exactly one `\n` |
+| Unused bib entries | Find bib entries no target cites, once per bib file (see below) |
+| BibTeX tidy | Check bibliography formatting with bibtex-tidy (the same arguments `paperkit bibtidy` would apply) |
+
+**Unused bib entries across targets.** With several mains sharing a bib file,
+an entry is unused only if no target using that file cites it. paperkit reads
+which bib files each target uses and what it cites from the target's `.aux`
+(`\bibdata`, `\citation`, including `\@input` files and `\nocite{*}`) or, with
+biber, its `.bcf`; no configuration is needed. With several targets, the
+result is printed once per bib file in a "Bibliography" block.
+
+When only some targets are built or checked (`paperkit build paper`), the
+others are taken from their existing `.aux` if it is newer than their sources,
+else from one draft LaTeX pass into a scratch directory (no PDF; the real
+output is untouched). If that is disabled or fails, entries not cited by the
+checked targets are listed as "other targets not checked", never as unused.
+
+```toml
+[checks.unused_bib]      # or simply: unused_bib = true | false
+ignore = ["some_key"]    # never reported as unused (e.g. staged for later)
+draft_pass = true        # resolve other targets with a draft pass when needed
+```
+
+**Page limits.** `[page_limits]` reports the total pages and the pages of
+content before the references and the acknowledgments, and flags a paper over
+its limits. A section starting mid-page counts that page. The sections are
+found by their headings, so nothing has to be marked up in the source.
+
+By default the acknowledgments and the references are both exempt: the
+counted content ends at whichever comes first. Many venues (most ACM and
+USENIX calls, for instance) exempt only the references and count
+acknowledgments as text. Set `ack_counts_as_content = true` for those, and the
+budget ends at the references heading instead:
+
+```toml
+[page_limits]
+before_refs = 14
+ack_counts_as_content = true   # acks sit inside the 14 pages
+```
+
+A check whose tool is missing (e.g. `pdffonts`, `bibtex-tidy`) is reported as
+**skipped** (yellow) and makes the verdict "OK with warnings", so it never
+passes silently. `paperkit check` runs in the Docker image by default, where
+all tools are installed; `--no-docker` uses the host's. The TeX Live line of
+the report comes from the build log, i.e. it names the engine that produced
+the PDF, wherever the report is generated.
+
+**Shipping the compiled bibliography.** Publishers often compile a submission
+without running BibTeX, and ask for the `.bbl` alongside the sources (Springer's
+LNCS checklist, for instance). `include_bbl = true`, or `paperkit zip --bbl`,
+copies each included main's `<main>.bbl` out of the build directory and stores
+it next to its `.tex` in the archive, which is where a publisher looks for it.
+Build first: if a `.bbl` is missing the command stops and says so rather than
+shipping an archive that cannot be compiled, and if a `.bbl` is older than its
+`.tex` or the bib file, it warns that the archive may not match the sources.
+
+## Profiles
+
+**`base`**: sensible defaults for any paper. With `sort = false` the two
+reordering arguments (`--sort=key`, `--sort-fields`) are dropped and the rest
+still applies. Default bibtex-tidy args: `--curly --blank-lines --sort=key --duplicates=key,doi,citation --sort-fields --trailing-commas --remove-empty-fields --enclosing-braces=title --align=13`.
+
+**`acm`**: for ACM conferences and journals. Currently identical to base; reserved for future ACM-specific defaults.
+
+## Docker
+
+The Docker image includes all engines and tools regardless of the current config, so switching between pdflatex/lualatex or bibtex/biber requires no rebuild.
+
+Pre-installed: TeX Live (all major collections + luatex + xetex), biber, pygments, poppler-utils, npm, bibtex-tidy.
+
+### Reproducible builds
+
+Two builds of the same sources differ in three places, all written by the PDF
+writer: the creation and modification dates, the random tags of subsetted
+fonts (`VHDZTM+Calibri` one run, `EJHWCU+Calibri` the next), and the trailer
+`/ID`. paperkit pins all three, so rebuilding gives byte-identical output.
+
+Every engine, bibtex and biber run gets `SOURCE_DATE_EPOCH` and
+`FORCE_SOURCE_DATE`, on the host and inside the container alike. The
+timestamp comes from `[build] source_date_epoch`:
+
+| Value | Meaning |
+|---|---|
+| `"git"` (default) | the committer date of HEAD |
+| an integer | that epoch |
+| an ISO date or date-time | that moment (dates are UTC midnight) |
+
+A `SOURCE_DATE_EPOCH` already set in your environment wins over the config.
+Outside a git repository, or before the first commit, paperkit warns that the
+build is not reproducible and uses the current time. The report prints the
+timestamp it used, so you can tell what a given PDF was built with:
+
+```
+Source date  1789898400 (2026-09-20 10:00:00 UTC, from git)
+```
+
+The archive is pinned the same way: `paperkit zip` stores the build
+timestamp on every entry rather than the files' own modification times, which
+git does not restore, and keeps only the executable bit of each mode. The same
+sources therefore archive to the same bytes from a fresh clone, on another
+machine.
+
+The trailer `/ID` needs help on older toolchains: from TeX Live 2024 on,
+xdvipdfmx derives it from the epoch, but earlier versions do not, so paperkit
+pins it from the epoch and the main's name (each main of a project gets its
+own). Your sources are untouched: the definition is passed on the engine's
+command line.
+
+### TeX Live from a dated snapshot
+
+`paperkit init` writes a `[texlive]` section pinned to a dated snapshot that
+this release was tested against, so a new project gets a reproducible TeX
+Live and a working `minted` without any network lookup at init time. Use
+`paperkit init --texlive distro` for the base image's `texlive-*` packages
+instead, which is whatever the distribution ships and changes (or disappears)
+as it moves on.
+
+With `source = "upstream"` paperkit runs the official `install-tl` against a
+tlnet repository, and a dated snapshot gives the same package set on every
+image rebuild:
+
+```toml
+[texlive]
+source = "upstream"            # "distro" (default) | "upstream"
+snapshot = "2026-09-18"        # dated snapshot from texlive.info
+tlpdb_sha512 = "bcd7c792..."   # optional: pin the snapshot's package database
+scheme = "small"               # install-tl scheme (without "scheme-")
+collections = [                # added on top of the scheme (without "collection-")
+    "latexextra", "fontsrecommended", "fontsextra", "publishers",
+    "mathscience", "pictures", "bibtexextra",
+]
+packages = []                  # extra individual packages (installed with tlmgr)
+docs = false                   # install documentation files
+sources = false                # install source files
+```
+
+Repository selection, highest precedence first:
+
+| Key | Repository |
+|---|---|
+| `repository = "https://..."` | Any tlnet URL, e.g. a private mirror |
+| `snapshot = "YYYY-MM-DD"` | `https://www.texlive.info/tlnet-archive/YYYY/MM/DD/tlnet` |
+| `year = 2025` | Frozen final repository of a closed release, from the TUG historic archive |
+| none | Live CTAN mirror: current packages, **not reproducible** (paperkit warns) |
+
+`snapshot` and `year` are mutually exclusive. Collection names are TeX Live's,
+not Debian's: Debian's `texlive-science` is `mathscience`, and
+`texlive-latex-extra` is `latexextra`.
+
+TeX Live is installed under `/opt/texlive` (added to `PATH`), `tlmgr` is left
+pointing at the same repository so later `tlmgr install` calls cannot pull
+newer packages, and no distro `texlive-*` packages are installed. The TeX Live
+layer comes before paperkit's tools, so it only rebuilds when `[texlive]` or
+the base image changes. `minted` works out of the box: TeX Live ships
+`latexminted` with its Python dependencies, and only a system `python3` is
+needed. This is the recommended setup on `ubuntu:26.04`, whose distro
+`minted` and `latexminted` versions do not work together.
+
+**What is pinned.** The snapshot fixes the TeX Live package set: install-tl
+checks every downloaded package against the snapshot's package database
+(`tlpkg/texlive.tlpdb`), and `tlpdb_sha512` fixes that database itself. The
+image build fails before downloading anything if the snapshot's database
+changed. To get the value:
+
+```bash
+curl -fsSL https://www.texlive.info/tlnet-archive/YYYY/MM/DD/tlnet/tlpkg/texlive.tlpdb.sha512
+```
+
+The base image is not pinned by the snapshot. It hardly matters once TeX comes
+from the snapshot (it only provides perl, python3 and paperkit's tools), but it
+can be pinned by digest:
+
+```toml
+[docker]
+base_image = "ubuntu:26.04@sha256:<digest>"
+```
+
+(`docker pull ubuntu:26.04 && docker image inspect --format '{{index .RepoDigests 0}}' ubuntu:26.04`
+prints it.)
+
+**Availability.** texlive.info is a single volunteer-run host. If it becomes
+unavailable, use `year = ...` for a closed release (the TUG historic archive is
+mirrored), or keep a copy of the snapshot on your own server and set
+`repository`.
+
+**Bumping.** `paperkit texlive-update` looks up the newest published snapshot,
+rewrites `snapshot` and `tlpdb_sha512` in `.paperkit.toml` and leaves the rest
+of the file alone; `--check` reports the move without editing. It is the only
+command that goes online: builds never do. Rebuild afterwards and diff the
+output PDF against the previous build. To move by hand, change `snapshot` and
+update `tlpdb_sha512` with the command above.
+
+## Development
+
+Development uses [uv](https://docs.astral.sh/uv/); `uv.lock` pins the
+development tools, so everyone formats and lints with the same versions.
+
+```bash
+uv sync                      # create .venv with paperkit and the dev tools
+./scripts/all_checks.sh      # headers, format, lint, types, tests (all below)
+
+uv run ruff check src tests  # linting (--fix applies the safe fixes)
+uv run ruff format src tests # formatting
+uv run mypy src              # type checking
+uv run pytest                # tests
+```
+
+Patches are welcome: [CONTRIBUTING.md](CONTRIBUTING.md) covers the checks a
+pull request is expected to pass and the sign-off it carries. Releases follow
+[RELEASING.md](RELEASING.md); changes are listed in
+[CHANGELOG.md](CHANGELOG.md).

paperkit-0.1.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+paperkit/__init__.py,sha256=n4tON0KUXgHbC6qTimdRMhzp5grdLG_fQfea_4R9Fms,208
+paperkit/archive.py,sha256=Njw21ZlsNtRvRCAsrVpDAh6A2HMW6SJeiSeDkbf-NWo,6527
+paperkit/bibliography.py,sha256=xXiTuHI_kxGAk4mg74IuOtie1PIrtUeiMcHu37uZbXY,12170
+paperkit/builder.py,sha256=9bwQ8UhFcQayktvc7zuC4RnPWLGFrvofTUTp-xSxyPQ,5768
+paperkit/checks.py,sha256=yptc1aSta_JcfGjVIESYu3ttSlPwWHEloEXfBMGHLO8,20085
+paperkit/cli.py,sha256=x9ERs2tXdS6UJoL-9WjXE2nyS8cqkltx5keXihhGe1k,21798
+paperkit/config.py,sha256=mNduurAwXq1V1QPfEabRZmzqDX-MlyT1WbYTB7nC5TY,15635
+paperkit/docker.py,sha256=iQov8rF6Uj5JvBTZA2C1CR--zxaFKctIyjiP3Q_fxiE,9351
+paperkit/pages.py,sha256=S7ldcH3aHD5ING78I5PIF6Mo0ZIuKnce77MX35kTsww,9480
+paperkit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+paperkit/report.py,sha256=2FmweRCPfQ29Uk8XB9IhopcyaClVqFM-tB7G-whyacg,8339
+paperkit/reproducible.py,sha256=k-bI35Eu0jKOaXJy-3qak7PdekBPEATXFNJDYMlxYZU,5572
+paperkit/texlive.py,sha256=qUIWi9H4wkOAsoOZSQBEaSSaUl48K3UQSMuIODi7ZKM,11763
+paperkit/text_export.py,sha256=tgr6zKFkGkBV-zY7nnkaXmjtClzQ5ZukWZqGKuOgkaw,6081
+paperkit/profiles/__init__.py,sha256=HyreMEwpWX93pZ8hNjBwYkpv6aeIkJvGpiaOS-kALVE,1573
+paperkit/profiles/acm.py,sha256=WrSiMQuQ19CyuT0Q_3xlv89r7pSDQwEy56WpUdsFpCc,262
+paperkit-0.1.0.dist-info/METADATA,sha256=K5Vhe4pv83W7YH6uqHFk8u79gGHxRW4V8yJRNoRRyNI,16725
+paperkit-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+paperkit-0.1.0.dist-info/entry_points.txt,sha256=fW_X5r3WTUz4nsUDsOQXq-bjiHMk1-OAkVunnMRGHfQ,47
+paperkit-0.1.0.dist-info/licenses/LICENSE,sha256=YQwYLmcoPLO6LM-2O6u_4Zl8eb4EFyoUFAwcE4aVHew,1083
+paperkit-0.1.0.dist-info/RECORD,,

paperkit-0.1.0.dist-info/WHEEL

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

paperkit-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+paperkit = paperkit.cli:main

paperkit-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vrije Universiteit Brussel
+
+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.