proof-pdf 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- proof_pdf-0.1.0/LICENSE +202 -0
- proof_pdf-0.1.0/NOTICE +19 -0
- proof_pdf-0.1.0/PKG-INFO +101 -0
- proof_pdf-0.1.0/README.md +75 -0
- proof_pdf-0.1.0/pyproject.toml +144 -0
- proof_pdf-0.1.0/src/proof_pdf/__init__.py +14 -0
- proof_pdf-0.1.0/src/proof_pdf/cli.py +300 -0
- proof_pdf-0.1.0/src/proof_pdf/colour.py +365 -0
- proof_pdf-0.1.0/src/proof_pdf/content.py +177 -0
- proof_pdf-0.1.0/src/proof_pdf/core.py +108 -0
- proof_pdf-0.1.0/src/proof_pdf/models.py +114 -0
- proof_pdf-0.1.0/src/proof_pdf/preview.py +170 -0
- proof_pdf-0.1.0/src/proof_pdf/py.typed +0 -0
- proof_pdf-0.1.0/src/proof_pdf/resolution.py +90 -0
- proof_pdf-0.1.0/src/proof_pdf/structure.py +242 -0
- proof_pdf-0.1.0/src/proof_pdf/verapdf.py +100 -0
- proof_pdf-0.1.0/tests/test_proof_pdf/__init__.py +1 -0
- proof_pdf-0.1.0/tests/test_proof_pdf/conftest.py +206 -0
- proof_pdf-0.1.0/tests/test_proof_pdf/test_cli.py +253 -0
- proof_pdf-0.1.0/tests/test_proof_pdf/test_colour.py +288 -0
- proof_pdf-0.1.0/tests/test_proof_pdf/test_content.py +122 -0
- proof_pdf-0.1.0/tests/test_proof_pdf/test_core.py +170 -0
- proof_pdf-0.1.0/tests/test_proof_pdf/test_preview.py +141 -0
- proof_pdf-0.1.0/tests/test_proof_pdf/test_resolution.py +129 -0
- proof_pdf-0.1.0/tests/test_proof_pdf/test_structure.py +231 -0
- proof_pdf-0.1.0/tests/test_proof_pdf/test_verapdf.py +79 -0
proof_pdf-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
proof_pdf-0.1.0/NOTICE
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
proof-pdf
|
|
2
|
+
Copyright 2026 Ilja Orlovs. Licensed under the Apache License, Version 2.0.
|
|
3
|
+
|
|
4
|
+
Python dependencies (installed by pip)
|
|
5
|
+
pikepdf MPL-2.0 (bundles qpdf, Apache-2.0)
|
|
6
|
+
Pillow MIT-CMU
|
|
7
|
+
Typer MIT
|
|
8
|
+
|
|
9
|
+
External programs, run as separate processes and never linked or bundled in the
|
|
10
|
+
Python package. Install them yourself, or use the project's Docker image.
|
|
11
|
+
veraPDF GPL-3.0-or-later OR MPL-2.0 (used here under MPL-2.0) https://verapdf.org
|
|
12
|
+
Ghostscript AGPL-3.0 (commercial licence available from Artifex) https://ghostscript.com
|
|
13
|
+
The Docker image redistributes Ghostscript; its source is available
|
|
14
|
+
from the Debian package (apt-get source ghostscript).
|
|
15
|
+
|
|
16
|
+
Docker images (releaseart/lualatex, releaseart/full) additionally contain
|
|
17
|
+
TeX Live 2025 mixed free licences (LuaTeX GPL-2.0-or-later; most packages LPPL-1.3c) https://tug.org/texlive
|
|
18
|
+
OpenJDK 21 JRE GPL-2.0 with Classpath Exception (full only, for veraPDF)
|
|
19
|
+
Debian GPL, LGPL, MIT and others; sources via `apt-get source <package>`
|
proof_pdf-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: proof-pdf
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Hold print PDFs to PDF/X-4 and PDF/A: veraPDF, page boxes, geometry, ink and image resolution.
|
|
5
|
+
Keywords: pdf,pdf/x-4,pdf/a,verapdf,prepress,print,preflight,ghostscript,lualatex
|
|
6
|
+
Author-Email: Ilja Orlovs <ilja@release.art>
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
License-File: NOTICE
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.15
|
|
14
|
+
Classifier: Topic :: Printing
|
|
15
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
16
|
+
Classifier: Typing :: Typed
|
|
17
|
+
Project-URL: Homepage, https://github.com/release-art/proofpress
|
|
18
|
+
Project-URL: Repository, https://github.com/release-art/proofpress
|
|
19
|
+
Project-URL: Issues, https://github.com/release-art/proofpress/issues
|
|
20
|
+
Project-URL: Changelog, https://github.com/release-art/proofpress/blob/main/CHANGELOG.md
|
|
21
|
+
Requires-Python: <3.16,>=3.15
|
|
22
|
+
Requires-Dist: pikepdf>=10.17.0
|
|
23
|
+
Requires-Dist: pillow>=12.3.0
|
|
24
|
+
Requires-Dist: typer>=0.27.3
|
|
25
|
+
Description-Content-Type: text/markdown
|
|
26
|
+
|
|
27
|
+
# proofpress
|
|
28
|
+
|
|
29
|
+
[](https://github.com/release-art/proofpress/actions/workflows/ci.yml)
|
|
30
|
+
[](https://pypi.org/project/proof-pdf)
|
|
31
|
+
[](LICENSE)
|
|
32
|
+
|
|
33
|
+
Open-source pieces of a print-on-demand pipeline, extracted from production use.
|
|
34
|
+
|
|
35
|
+
| Piece | What it is |
|
|
36
|
+
|---|---|
|
|
37
|
+
| [`proof-pdf`](#proof-pdf) | CLI and library that hold a print PDF to PDF/X-4 and PDF/A. |
|
|
38
|
+
| [`releaseart/lualatex`](#docker-images) | TeX Live 2025 with LuaLaTeX. |
|
|
39
|
+
| [`releaseart/full`](#docker-images) | `lualatex` plus Ghostscript, veraPDF and `proof-pdf`. |
|
|
40
|
+
|
|
41
|
+
## proof-pdf
|
|
42
|
+
|
|
43
|
+
`verify` runs four layers, each of which can be switched off:
|
|
44
|
+
|
|
45
|
+
- **PDF/A** with [veraPDF](https://verapdf.org) (`--flavour 2b` by default; `--no-pdfa` to skip).
|
|
46
|
+
- **PDF/X-4 structure**: page boxes, `/Trapped`, the `GTS_PDFX` output intent and the XMP version key (`--no-pdfx`).
|
|
47
|
+
- **Geometry**: trim and bleed against the finished size you expect. Runs only when `--trim-mm` is given (`--bleed-mm`, `--tolerance-mm`).
|
|
48
|
+
- **Colour**: total ink coverage (`--max-tac`, 300% default), stray RGB (`--strict-cmyk`), effective image DPI (`--min-dpi`, 300 default),
|
|
49
|
+
overprint and rich-black small text (`--no-colour`).
|
|
50
|
+
|
|
51
|
+
`preview` rasterises each page and draws the trim, bleed and safe guides from the PDF's own boxes, so a geometry finding can be seen.
|
|
52
|
+
|
|
53
|
+
```zsh
|
|
54
|
+
pip install proof-pdf # Python 3.15; needs verapdf and gs (Ghostscript) on PATH
|
|
55
|
+
|
|
56
|
+
proof-pdf verify job/ --trim-mm 105x148 --bleed-mm 3 --exclude '*_preview.pdf'
|
|
57
|
+
proof-pdf verify card.pdf --json # machine-readable findings, for CI
|
|
58
|
+
proof-pdf preview card.pdf --dpi 150
|
|
59
|
+
proof-pdf --version # version, plus the commit when built from an image
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
- Arguments are files or directories; a directory expands to every PDF beneath it, minus `--exclude` globs (relative to that directory).
|
|
63
|
+
- **A check whose tool is missing fails, it is never skipped**: a file that can't be confirmed must not read as OK.
|
|
64
|
+
- Errors fail the file and exit 1. Warnings are advisory. `--quiet` prints nothing, for exit-code-only use.
|
|
65
|
+
|
|
66
|
+
As a library, `proof_pdf.core.verify_file(path, profile)` returns a `FileReport` of `Finding`s; see `proof_pdf.models.Profile`.
|
|
67
|
+
|
|
68
|
+
## Docker images
|
|
69
|
+
|
|
70
|
+
```zsh
|
|
71
|
+
docker run --rm --user "$(id -u):$(id -g)" -v "$PWD":/work releaseart/full verify job/ --trim-mm 105x148
|
|
72
|
+
docker run --rm --user "$(id -u):$(id -g)" -v "$PWD":/work releaseart/lualatex lualatex -interaction=nonstopmode book.tex
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
`releaseart/lualatex` is TeX Live 2025 (the `collection-latex`, `luatex`, `latexrecommended` and `fontsrecommended` sets plus a few common
|
|
76
|
+
packages) on Debian, with no Java or Python. Add your own packages in a derived image with `tlmgr install`.
|
|
77
|
+
`releaseart/full` adds Ghostscript, veraPDF (with a JRE) and `proof-pdf`.
|
|
78
|
+
|
|
79
|
+
Both are published for `linux/amd64` and `linux/arm64`. `:latest` is the most recent build: the weekly one of `main`
|
|
80
|
+
(Mondays, which also picks up base-image updates) or a tagged release, whichever is newer. `:1.2.3` comes from a git tag
|
|
81
|
+
and `:tl2025` tracks the TeX Live year. Each image reports its commit in `PROOFPRESS_REVISION` and the OCI `revision` label.
|
|
82
|
+
|
|
83
|
+
## Development
|
|
84
|
+
|
|
85
|
+
Python 3.15 and [PDM](https://pdm-project.org).
|
|
86
|
+
|
|
87
|
+
```zsh
|
|
88
|
+
git config core.hooksPath .githooks # ruff + pyright before each commit
|
|
89
|
+
pdm install
|
|
90
|
+
bin/autoformat.sh # ruff format + fix, pyright
|
|
91
|
+
bin/test.sh # pytest
|
|
92
|
+
bin/docker/build.sh && bin/docker/smoke.sh
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md). To release, add the version to [CHANGELOG.md](CHANGELOG.md) and push a tag:
|
|
96
|
+
`git tag v1.2.3 && git push origin v1.2.3`. The tag is the version; it publishes to PyPI (TestPyPI first), creates a GitHub
|
|
97
|
+
Release and pushes both images.
|
|
98
|
+
|
|
99
|
+
## Licence
|
|
100
|
+
|
|
101
|
+
Apache-2.0. Third-party terms, including Ghostscript (AGPL-3.0) and veraPDF, are in [NOTICE](NOTICE).
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# proofpress
|
|
2
|
+
|
|
3
|
+
[](https://github.com/release-art/proofpress/actions/workflows/ci.yml)
|
|
4
|
+
[](https://pypi.org/project/proof-pdf)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
|
|
7
|
+
Open-source pieces of a print-on-demand pipeline, extracted from production use.
|
|
8
|
+
|
|
9
|
+
| Piece | What it is |
|
|
10
|
+
|---|---|
|
|
11
|
+
| [`proof-pdf`](#proof-pdf) | CLI and library that hold a print PDF to PDF/X-4 and PDF/A. |
|
|
12
|
+
| [`releaseart/lualatex`](#docker-images) | TeX Live 2025 with LuaLaTeX. |
|
|
13
|
+
| [`releaseart/full`](#docker-images) | `lualatex` plus Ghostscript, veraPDF and `proof-pdf`. |
|
|
14
|
+
|
|
15
|
+
## proof-pdf
|
|
16
|
+
|
|
17
|
+
`verify` runs four layers, each of which can be switched off:
|
|
18
|
+
|
|
19
|
+
- **PDF/A** with [veraPDF](https://verapdf.org) (`--flavour 2b` by default; `--no-pdfa` to skip).
|
|
20
|
+
- **PDF/X-4 structure**: page boxes, `/Trapped`, the `GTS_PDFX` output intent and the XMP version key (`--no-pdfx`).
|
|
21
|
+
- **Geometry**: trim and bleed against the finished size you expect. Runs only when `--trim-mm` is given (`--bleed-mm`, `--tolerance-mm`).
|
|
22
|
+
- **Colour**: total ink coverage (`--max-tac`, 300% default), stray RGB (`--strict-cmyk`), effective image DPI (`--min-dpi`, 300 default),
|
|
23
|
+
overprint and rich-black small text (`--no-colour`).
|
|
24
|
+
|
|
25
|
+
`preview` rasterises each page and draws the trim, bleed and safe guides from the PDF's own boxes, so a geometry finding can be seen.
|
|
26
|
+
|
|
27
|
+
```zsh
|
|
28
|
+
pip install proof-pdf # Python 3.15; needs verapdf and gs (Ghostscript) on PATH
|
|
29
|
+
|
|
30
|
+
proof-pdf verify job/ --trim-mm 105x148 --bleed-mm 3 --exclude '*_preview.pdf'
|
|
31
|
+
proof-pdf verify card.pdf --json # machine-readable findings, for CI
|
|
32
|
+
proof-pdf preview card.pdf --dpi 150
|
|
33
|
+
proof-pdf --version # version, plus the commit when built from an image
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
- Arguments are files or directories; a directory expands to every PDF beneath it, minus `--exclude` globs (relative to that directory).
|
|
37
|
+
- **A check whose tool is missing fails, it is never skipped**: a file that can't be confirmed must not read as OK.
|
|
38
|
+
- Errors fail the file and exit 1. Warnings are advisory. `--quiet` prints nothing, for exit-code-only use.
|
|
39
|
+
|
|
40
|
+
As a library, `proof_pdf.core.verify_file(path, profile)` returns a `FileReport` of `Finding`s; see `proof_pdf.models.Profile`.
|
|
41
|
+
|
|
42
|
+
## Docker images
|
|
43
|
+
|
|
44
|
+
```zsh
|
|
45
|
+
docker run --rm --user "$(id -u):$(id -g)" -v "$PWD":/work releaseart/full verify job/ --trim-mm 105x148
|
|
46
|
+
docker run --rm --user "$(id -u):$(id -g)" -v "$PWD":/work releaseart/lualatex lualatex -interaction=nonstopmode book.tex
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
`releaseart/lualatex` is TeX Live 2025 (the `collection-latex`, `luatex`, `latexrecommended` and `fontsrecommended` sets plus a few common
|
|
50
|
+
packages) on Debian, with no Java or Python. Add your own packages in a derived image with `tlmgr install`.
|
|
51
|
+
`releaseart/full` adds Ghostscript, veraPDF (with a JRE) and `proof-pdf`.
|
|
52
|
+
|
|
53
|
+
Both are published for `linux/amd64` and `linux/arm64`. `:latest` is the most recent build: the weekly one of `main`
|
|
54
|
+
(Mondays, which also picks up base-image updates) or a tagged release, whichever is newer. `:1.2.3` comes from a git tag
|
|
55
|
+
and `:tl2025` tracks the TeX Live year. Each image reports its commit in `PROOFPRESS_REVISION` and the OCI `revision` label.
|
|
56
|
+
|
|
57
|
+
## Development
|
|
58
|
+
|
|
59
|
+
Python 3.15 and [PDM](https://pdm-project.org).
|
|
60
|
+
|
|
61
|
+
```zsh
|
|
62
|
+
git config core.hooksPath .githooks # ruff + pyright before each commit
|
|
63
|
+
pdm install
|
|
64
|
+
bin/autoformat.sh # ruff format + fix, pyright
|
|
65
|
+
bin/test.sh # pytest
|
|
66
|
+
bin/docker/build.sh && bin/docker/smoke.sh
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md). To release, add the version to [CHANGELOG.md](CHANGELOG.md) and push a tag:
|
|
70
|
+
`git tag v1.2.3 && git push origin v1.2.3`. The tag is the version; it publishes to PyPI (TestPyPI first), creates a GitHub
|
|
71
|
+
Release and pushes both images.
|
|
72
|
+
|
|
73
|
+
## Licence
|
|
74
|
+
|
|
75
|
+
Apache-2.0. Third-party terms, including Ghostscript (AGPL-3.0) and veraPDF, are in [NOTICE](NOTICE).
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "proof-pdf"
|
|
3
|
+
dynamic = []
|
|
4
|
+
description = "Hold print PDFs to PDF/X-4 and PDF/A: veraPDF, page boxes, geometry, ink and image resolution."
|
|
5
|
+
authors = [
|
|
6
|
+
{ name = "Ilja Orlovs", email = "ilja@release.art" },
|
|
7
|
+
]
|
|
8
|
+
license = "Apache-2.0"
|
|
9
|
+
license-files = [
|
|
10
|
+
"LICENSE",
|
|
11
|
+
"NOTICE",
|
|
12
|
+
]
|
|
13
|
+
readme = "README.md"
|
|
14
|
+
keywords = [
|
|
15
|
+
"pdf",
|
|
16
|
+
"pdf/x-4",
|
|
17
|
+
"pdf/a",
|
|
18
|
+
"verapdf",
|
|
19
|
+
"prepress",
|
|
20
|
+
"print",
|
|
21
|
+
"preflight",
|
|
22
|
+
"ghostscript",
|
|
23
|
+
"lualatex",
|
|
24
|
+
]
|
|
25
|
+
classifiers = [
|
|
26
|
+
"Development Status :: 3 - Alpha",
|
|
27
|
+
"Environment :: Console",
|
|
28
|
+
"Intended Audience :: Developers",
|
|
29
|
+
"Programming Language :: Python :: 3.15",
|
|
30
|
+
"Topic :: Printing",
|
|
31
|
+
"Topic :: Software Development :: Quality Assurance",
|
|
32
|
+
"Typing :: Typed",
|
|
33
|
+
]
|
|
34
|
+
requires-python = ">=3.15,<3.16"
|
|
35
|
+
dependencies = [
|
|
36
|
+
"pikepdf>=10.17.0",
|
|
37
|
+
"pillow>=12.3.0",
|
|
38
|
+
"typer>=0.27.3",
|
|
39
|
+
]
|
|
40
|
+
version = "0.1.0"
|
|
41
|
+
|
|
42
|
+
[project.urls]
|
|
43
|
+
Homepage = "https://github.com/release-art/proofpress"
|
|
44
|
+
Repository = "https://github.com/release-art/proofpress"
|
|
45
|
+
Issues = "https://github.com/release-art/proofpress/issues"
|
|
46
|
+
Changelog = "https://github.com/release-art/proofpress/blob/main/CHANGELOG.md"
|
|
47
|
+
|
|
48
|
+
[project.scripts]
|
|
49
|
+
proof-pdf = "proof_pdf.cli:pdf_app"
|
|
50
|
+
|
|
51
|
+
[tool.ruff]
|
|
52
|
+
target-version = "py315"
|
|
53
|
+
line-length = 120
|
|
54
|
+
|
|
55
|
+
[tool.ruff.lint]
|
|
56
|
+
select = [
|
|
57
|
+
"A",
|
|
58
|
+
"B",
|
|
59
|
+
"C",
|
|
60
|
+
"E",
|
|
61
|
+
"F",
|
|
62
|
+
"I",
|
|
63
|
+
"W",
|
|
64
|
+
"N",
|
|
65
|
+
"C4",
|
|
66
|
+
"T20",
|
|
67
|
+
"PTH",
|
|
68
|
+
]
|
|
69
|
+
ignore = [
|
|
70
|
+
"N802",
|
|
71
|
+
]
|
|
72
|
+
|
|
73
|
+
[tool.ruff.lint.per-file-ignores]
|
|
74
|
+
"__init__.py" = [
|
|
75
|
+
"F401",
|
|
76
|
+
"E402",
|
|
77
|
+
]
|
|
78
|
+
"cli.py" = [
|
|
79
|
+
"B008",
|
|
80
|
+
]
|
|
81
|
+
|
|
82
|
+
[tool.ruff.lint.isort]
|
|
83
|
+
order-by-type = true
|
|
84
|
+
combine-as-imports = true
|
|
85
|
+
force-wrap-aliases = true
|
|
86
|
+
known-first-party = [
|
|
87
|
+
"proof_pdf",
|
|
88
|
+
]
|
|
89
|
+
forced-separate = [
|
|
90
|
+
"tests",
|
|
91
|
+
]
|
|
92
|
+
|
|
93
|
+
[tool.ruff.format]
|
|
94
|
+
line-ending = "lf"
|
|
95
|
+
|
|
96
|
+
[tool.pyright]
|
|
97
|
+
include = [
|
|
98
|
+
"src",
|
|
99
|
+
"tests",
|
|
100
|
+
]
|
|
101
|
+
pythonVersion = "3.15"
|
|
102
|
+
|
|
103
|
+
[tool.pdm]
|
|
104
|
+
distribution = true
|
|
105
|
+
|
|
106
|
+
[tool.pdm.version]
|
|
107
|
+
source = "scm"
|
|
108
|
+
tag_regex = "^v(?P<version>\\d+\\.\\d+\\.\\d+.*)$"
|
|
109
|
+
fallback_version = "0.0.0"
|
|
110
|
+
|
|
111
|
+
[tool.pdm.build]
|
|
112
|
+
package-dir = "src"
|
|
113
|
+
includes = [
|
|
114
|
+
"src/proof_pdf",
|
|
115
|
+
]
|
|
116
|
+
|
|
117
|
+
[tool.pytest.ini_options]
|
|
118
|
+
addopts = "-v -l --color=yes --cov=proof_pdf --cov-report term-missing --no-cov-on-fail"
|
|
119
|
+
pythonpath = [
|
|
120
|
+
"src",
|
|
121
|
+
]
|
|
122
|
+
testpaths = [
|
|
123
|
+
"tests",
|
|
124
|
+
]
|
|
125
|
+
timeout = 15
|
|
126
|
+
markers = [
|
|
127
|
+
"container: needs real veraPDF and Ghostscript (skipped without them, run in the image)",
|
|
128
|
+
]
|
|
129
|
+
|
|
130
|
+
[build-system]
|
|
131
|
+
requires = [
|
|
132
|
+
"pdm-backend",
|
|
133
|
+
]
|
|
134
|
+
build-backend = "pdm.backend"
|
|
135
|
+
|
|
136
|
+
[dependency-groups]
|
|
137
|
+
dev = [
|
|
138
|
+
"pytest>=9.1.1",
|
|
139
|
+
"pytest-cov>=7.1.0",
|
|
140
|
+
"pytest-mock>=3.16.0",
|
|
141
|
+
"pytest-timeout>=2.4.0",
|
|
142
|
+
"ruff>=0.17.1",
|
|
143
|
+
"pyright>=1.1.414",
|
|
144
|
+
]
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"""Print-PDF conformance verification.
|
|
2
|
+
|
|
3
|
+
Wraps veraPDF (the PDF/A engine) and adds the checks veraPDF cannot make: the
|
|
4
|
+
PDF/X-4 structural identity (page boxes, ``/Trapped``, the X output intent and
|
|
5
|
+
XMP), the finished-page geometry, and best-effort colour sanity (total ink
|
|
6
|
+
coverage, overprint, rich-black small text, stray RGB, effective image DPI).
|
|
7
|
+
|
|
8
|
+
The entry point is :func:`proof_pdf.core.verify_file`; the CLI group lives in
|
|
9
|
+
:mod:`proof_pdf.cli` and is the ``proof-pdf`` console script.
|
|
10
|
+
|
|
11
|
+
The package takes PDF paths and nothing else. The finished-page geometry it checks
|
|
12
|
+
against is a parameter (:class:`PageGeometry`) with no default, so a file from a
|
|
13
|
+
printer is held to its own dimensions or the layer is skipped.
|
|
14
|
+
"""
|