kbiw 0.1.1__tar.gz

kbiw-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

kbiw-0.1.1/MANIFEST.in

@@ -0,0 +1,2 @@
+include kbiw/conf/*.*
+include kbiw/conf/schemas/*.*

kbiw-0.1.1/PKG-INFO

@@ -0,0 +1,335 @@
+Metadata-Version: 2.4
+Name: kbiw
+Version: 0.1.1
+Summary: KB Image Workflow Tool
+Author-email: Johan van der Knijff <johan.vanderknijff@kb.nl>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/KBNLresearch/kbiw
+Project-URL: Issues, https://github.com/KBNLresearch/kbiw/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lxml
+Requires-Dist: pyvips
+Requires-Dist: jpylyzer
+Requires-Dist: pyexiftool
+Dynamic: license-file
+
+# KB Image Workflow Tool
+
+## About this software
+
+Kbiw converts image files in digitisation batches to JP2 (JPEG 2000 Part 1) format using the [Grok](https://github.com/GrokImageCompression/grok) codec. It clones the structure of the input directory, and then replicates it in the output directory. The JP2 images are then subjected to the following quality checks:
+
+1. Pixel comparison between each pair of source and destination images (using [libvips](https://www.libvips.org/) and [pyvips](https://libvips.github.io/pyvips/)).
+2. Check of extracted technical properties (using [jpylyzer](https://jpylyzer.openpreservation.org/)) against a user-defined [Schematron](http://en.wikipedia.org/wiki/Schematron) profile.
+
+The software also generates checksums of all converted images.
+
+## Dependencies
+
+- Python (tested with versions 3.12.3 and 3.14.5)
+- [Grok JPEG 2000 codec](https://github.com/GrokImageCompression/grok) (tested with version ??)
+- [Libvips](https://www.libvips.org/)
+
+## Installation of dependencies
+
+### Grok (all platforms)
+
+1. Download the latest binaries of the Grok image compression software for your platform from:
+
+   <https://github.com/GrokImageCompression/grok/releases>
+
+2. Extract the ZIP file to your local file system, and make a note of the installation location. You'll need to enter this later in the kbiw configuration file.
+
+### Libvips
+
+#### Linux (Ubuntu, Linux Mint)
+
+Install libvips using:
+
+```
+sudo apt install libvips-dev --no-install-recommends
+```
+
+#### macOS
+
+TODO
+
+#### Windows
+
+1. Download the latest release from the [build-win64-mxe repository](https://github.com/libvips/build-win64-mxe/releases). For a 64 bit Windows system you need the ZIP file that follows the "vips-dev-x64-all-x.y.z.zip" naming pattern (e.g. vips-dev-x64-all-8.18.2.zip).
+
+2. Extract the ZIP file to your local file system, and make a note of the installation location (e.g. "C:\vips-dev"). You'll need to enter this later in the kbiw configuration file.
+
+### ExifTool
+
+#### Linux (Ubuntu, Linux Mint)
+
+Install ExifTool using:
+
+```
+sudo apt install libimage-exiftool-perl
+```
+
+#### macOS
+
+TODO
+
+#### Windows
+
+1. Download the 64-bit Windows executable from the [ExifTool website](https://exiftool.org/index.html).
+
+2. Extract the ZIP file to your local file system.
+
+3. In the extracted folder, rename the ExifTool executable ("exiftool(-k).exe") to "exiftool.exe.
+
+4. Make a note of the full path to the executable (e.g. "C:\exiftool\exiftool.exe"). You'll need to enter this later in the kbiw configuration file.
+
+## Installation of kbiw
+
+As of 2026, [uv](https://docs.astral.sh/uv/) appears to be the most straightforward tool for installing Python applications on a variety of platforms (Linux, MacOS, Windows).
+
+### uv installation
+
+First, check if uv is installed on your system by typing the uv command in a terminal:
+
+```
+uv
+```
+
+If this results in a help message, uv is installed, and you can skip directly to the "imgquad installation" section below. If not, you first need to install uv.
+
+On Linux and MacOS you can install uv with the following command:
+
+```
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Alternatively, you can use wget if your system doesn't have curl installed:
+
+```
+wget -qO- https://astral.sh/uv/install.sh | sh
+```
+
+To install uv on Windows, open a Powershell terminal, and run the following command:
+
+```
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+Regardless of the operating system, in some cases the installation script will update your system's configuration to make the location of the uv executable globally accessible. If this happens, just close your current terminal, and open a new one for these changes to take effect. Pay attention to the screen output of the installation script for any details on this.
+
+### kbiw installation
+
+Use the following command to install kbiw (all platforms):
+
+```
+uv tool install kbiw
+```
+
+Then run kbiw once:
+
+```
+kbiw
+```
+
+Depending on your system, kbiw will now create a configuration folder (see next section).
+
+## Configuration
+
+Before you can use kbiw, you need to edit the configuration file, which is located in the configuration folder. The configuration folder has the name "kbiw", and its location depends on your operating system:
+
+- For Linux and MacOS, the configuration folder is a subdirectory of the location defined by the environment variable *$XDG_CONFIG_HOME*. If this variable is not set, it will be a subdirectory of the *.config* directory in the user's home folder (e.g. `/home/johan/.config/kbiw`). Note that the *.config* directory is hidden by default.
+- For Windows, the configuration folder is a subdirectory of of the *AppData\Local* folder (e.g. `C:\Users\johan\AppData\Local\kbiw`).
+
+Open the configuration file ("config.json") in a text editor, and edit the following values:
+
+|Variable|Meaning|Examples|
+|:--|:--|:--|
+|grokDir|Grok installation directory|`C:/Grok` (Windows); `~/grok` (Linux)|
+|exifToolExecutable|ExifTool executable|`C:/exiftool/exiftool.exe` (Windows); `/bin/exiftool` (Linux)|
+|vipsBinDir|Libvips binary dir (only needed on Windows, ignored on Linux/macOS)|`C:/vips-dev/bin` (Windows)|
+
+Here's an example for a Windows system:
+
+
+```json
+{
+  "grokDir": "`C:/Grok",
+  "exifToolExecutable": "C:/exiftool/exiftool.exe",
+  "vipsBinDir": "C:/vips-dev/bin",
+  :
+}
+```
+
+## upgrade kbiw
+
+Use the following command to upgrade an existing kbiw installation to the latest version:
+
+```
+uv tool upgrade kbiw
+```
+
+<!---
+
+## Command-line syntax
+
+The general syntax of imgquad is:
+
+```
+usage: imgquad [-h] [--version] {process,list,copyps} ...
+```
+
+Imgquad has three sub-commands:
+
+|Command|Description|
+|:-----|:--|
+|process|Process a batch.|
+|list|List available profiles and schemas.|
+|copyps|Copy default profiles and schemas to user directory.|
+
+
+
+### process command
+
+Run imgquad with the *process* command to process a batch. The syntax is:
+
+```
+usage: imgquad process [-h] [--prefixout PREFIXOUT] [--outdir OUTDIR]
+                       [--delimiter DELIMITER] [--verbose]
+                       profile batchDir
+```
+
+The *process* command expects the following positional arguments: 
+
+|Argument|Description|
+|:-----|:--|
+|profile|This defines the validation profile. Note that any file paths entered here will be ignored, as Imgquad only accepts  profiles from the profiles directory. You can just enter the file name without the path. Use the *list* command to list all available profiles.|
+|batchDir|This defines the batch directory that will be analyzed.|
+
+In addition, the following optional arguments are available:
+
+|Argument|Description|
+|:-----|:--|
+|--prefixout, -p|This defines a text prefix on which the names of the output files are based (default: "pq").|
+|--outdir, -o|This defines the directory where output is written (default: current working directory from which imgquad is launched).|
+|--delimiter, -d|This defines the delimiter that is used in the output summary file (default: ';')|
+|--verbose, -b|This tells imgquad to report Schematron output in verbose format.|
+
+In the simplest case, we can call imgquad with the profile and the batch directory as the only arguments:
+
+```
+imgquad process beeldstudio-retro.xml ./mybatch
+```
+
+Imgquad will now recursively traverse all directories and files inside the "mybatch" directory, and analyse all image files (based on a file extension match).
+
+### list command
+
+Run imgquad with the *list* command to get a list of the available profiles and schemas, as well as their locations. For example:
+
+```
+imgquad list
+```
+
+Results in:
+
+```
+Available profiles (directory /home/johan/.config/imgquad/profiles):
+  - mh-2025-tiff.xml
+Available schemas (directory /home/johan/.config/imgquad/schemas):
+  - mh-2025-tiff-600.sch
+```
+
+
+
+## Schemas
+
+Schemas contain the Schematron rules on which the quality assessment is based. Some background information about this type of rule-based validation can be found in [this blog post](https://www.bitsgalore.org/2012/09/04/automated-assessment-jp2-against-technical-profile). Currently the following schemas are included:
+
+### mh-2025-tiff-600.sch
+
+This is a schema for digitised medieval manuscripts. It includes the following checks:
+
+|Check|Value|
+|:---|:---|
+|Image format|TIFF|
+|ICC profile name|eciRGB v2|
+|XResolution TIFF tag|tag exists|
+|YResolution TIFF tag|tag exists|
+|XResolution value|600 (+/- 1) |
+|YResolution value|600 (+/- 1) |
+|ResolutionUnit TIFF tag|tag exists|
+|ResolutionUnit value|2 (inches)|
+|ImageWidth TIFF tag|tag exists|
+|ImageLength TIFF tag|tag exists|
+|BitsPerSample TIFF tag|tag exists|
+|BitsPerSample value|'8 8 8'|
+|ICCProfile TIFF tag|tag exists|
+|Copyright TIFF tag|tag exists|
+|NewSubfileType TIFF tag|at most 1 instance of this tag|
+|SubIFDs TIFF tag|tag does not exist|
+|Compression EXIF tag|tag exists|
+|Compression|1 (Uncompressed)|
+|Software EXIF tag|tag exists|
+|Software value|not empty|
+|DateTimeOriginal EXIF tag|tag exists|
+|DateTimeOriginal value|not empty|
+|Model EXIF tag|tag exists|
+|Model value|not empty|
+|Make EXIF tag|tag exists|
+|Make value|not empty|
+|ShutterSpeedValue EXIF tag|tag exists|
+|ShutterSpeedValue value|not empty|
+|ApertureValue EXIF tag|tag exists|
+|ApertureValue value|not empty|
+|ISOSpeedRatings EXIF tag|tag exists|
+|ISOSpeedRatings value|not empty|
+|photoshop:Headline|defined in XMP metadata as either element `rdf:RDF/rdf:Description/photoshop:Headline`, or attribute `rdf:RDF/rdf:Description/@photoshop:Headline`|
+|photoshop:Headline value|not empty|
+|photoshop:Credit|defined in XMP metadata as either element `rdf:RDF/rdf:Description/photoshop:Credit`, or attribute `rdf:RDF/rdf:Description/@photoshop:Credit`|
+|photoshop:Credit value|not empty|
+
+The schema also includes an additional check on any exceptions that occurred while parsing the image, as this may indicate a corrupted file.
+
+### mh-2025-tiff-300.sch
+
+This schema is identical to the mh-2025-tiff-600.sch schema, except for the checks on the XResolution and YResolution values:
+
+|Check|Value|
+|:---|:---|
+|XResolution value|300 (+/- 1) |
+|YResolution value|300 (+/- 1) |
+
+## Output
+
+Imgquad reports the following output:
+
+### Comprehensive output file (XML)
+
+For each batch, Imgquad generates one comprehensive output file in XML format. This file contains, for each image, all extracted properties, as well as the Schematron report and the assessment status.
+
+### Summary file (CSV)
+
+This is a comma-delimited text file that summarises the analysis. At the minimum, Imgquad reports the following columns for each image:
+
+|Column|Description|
+|:-----|:--|
+|file|Full path to the image file.|
+|validationSuccess|Flag with value *True* if Schematron validation was succesful, and *False* if not. A value *False* indicates that the file could not be validated (e.g. because no matching schema was found, or the validation resulted in an unexpected exception)|
+|validationOutcome|The outcome of the Schematron validation/assessment. Value is *Pass* if file passed all tests, and *Fail* otherwise. Note that it is automatically set to *Fail* if the Schematron validation was unsuccessful (i.e. "validationSuccess" is *False*)|
+|validationErrors|List of validation errors (separated by "\|" characters).|
+
+In addition, the summary file contains additional columns with the properties that are defined by the *summaryProperty* elements in the profile.
+
+-->
+
+## Licensing
+
+KBiw is released under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). Parts of the code were inspired by the Bodeleian's [Image Processing](https://github.com/bodleian/image-processing) library.
+
+
+