Changed:

• ocrd_network: Use ocrd-all-tool.json bundled by core instead of download from website, #1257, #1260
• 🔥 ocrd network client processing processor renamed ocrd network client processing run, #1269
• ocrd network client processing run supports blocking behavior with --block by polling job status, #1265, #1269

Added:

• ocrd network client workflow run Run, optionally blocking, a workflow on the processing server, #1265, #1269
• ocrd network client workflow check-status to get the status of a workflow job, #1269
• ocrd network client processing check-status to get the status of a processing (processor) job, #1269
• ocrd network client discovery processors to list the processors deployed in the processing server, #1269
• ocrd network client discovery processor to get the ocrd-tool.json of a deployed processor, #1269
• ocrd network client processing check-log to retrieve the log data for a processing job, #1269
• Environment variables OCRD_NETWORK_CLIENT_POLLING_SLEEP and OCRD_NETWORK_CLIENT_POLLING_TIMEOUT to control polling interval and timeout for ocrd network client {processing processor,workflow run, #1269
• ocrd workspace clone/Resolver.workspace_from_url: with clobber_mets=False, raise a FileExistsError for existing mets.xml on disk, #563, #1268
• ocrd workspace find --download: print the the correct, up-to-date field, not None, #1202, #1266

Fixed:

• Sanitize self.imageFilename for the pcGtsId to ensure it is a valid xml:id, #1271

Changed:

• 🔥 OcrdPage as proxy of PcGtsType instead of alias; also contains etree and mapping now
• 🔥 Processor.zip_input_files now can throw ocrd.NonUniqueInputFile and ocrd.MissingInputFile
  (the latter only if OCRD_MISSING_INPUT=ABORT)
• 🔥 Processor.zip_input_files does not by default use require_first anymore
  (so the first file in any input file tuple per page can be None as well)
• 🔥 no more Workspace.overwrite_mode, merely delegate to OCRD_EXISTING_OUTPUT=OVERWRITE
• 🎨 improve on docs result for ocrd_utils.config

Added:

• 👉 OCRD_DOWNLOAD_INPUT for whether input files should be downloaded before processing
• 👉 OCRD_MISSING_INPUT for how to handle missing input files (SKIP or ABORT)
• 👉 OCRD_MISSING_OUTPUT for how to handle processing failures (SKIP or ABORT or COPY)
  the latter behaves like ocrd-dummy for the failed page(s)
• 👉 OCRD_EXISTING_OUTPUT for how to handle existing output files (SKIP or ABORT or OVERWRITE)
• new CLI option --debug as short-hand for ABORT choices above
• Processor.logger set up by constructor already (for re-use by processor implementors)
• default-expand and validate ocrd_tool.json in Processor constructor, log invalidities
• handle JSON deprecation in ocrd_tool.json by reporting warnings

#1240 for details

Changed:

• 🔥 Deprecate Processor.process
• update spec to v3.25.0, which requires annotating fileGrp cardinality in ocrd-tool.json
• 🔥 Remove passing non-processing kwargs to Processor constructor, add as members..
  (i.e. show_help, dump_json, dump_module_dir, list_resources, show_resource, resolve_resource)
• 🔥 Deprecate passing processing arg / kwargs to Processor constructor..
  (i.e. workspace, page_id, input_file_grp, output_file_grp; now all set by run_processor)
• 🔥 Deprecate passing ocrd-tool.json metadata to Processor constructor
• ocrd.processor: Handle loading of bundled ocrd-tool.json generically

Added:

• Processor.process_workspace: process a complete workspace, with default implementation
• Processor.process_page_file: process an OcrdFile, with default implementation
• Processor.process_page_pcgts: process a single OcrdPage, produce a single OcrdPage, required to implement
• Processor.verify: handle fileGrp cardinality verification, with default implementation
• Processor.setup: to set up processor before processing, optional

Fixed:

• Build and tests fixed, no functional changes from #1258

Changed:

• Additional docker base images with preinstalled tensorflow 1 (core-cuda-tf1), tensorflow 2 (core-cuda-tf2) and torch (core-cuda-torch), #1239
• Resource Manager: Skip instead of raise an exception download if target file already exists (unless --overwrite), #1246
• Resource Manager: Try to use bundled ocrd-all-tool.json if available, #1250, OCR-D/all#444

Added:

• ocrd process does support -U/--mets-server, #1243

Fixed:

• ocrd process-derived tasks are not run in a temporary directory when not called from within workspace, #1243
• regression from #1238 where processors failed that had required parameters, #1255, #1256
• METS Server: Unlink UDS sockert file if it exists before startup, #1244
• Resource Manager: Do not create zero-size files for failing downloads, #1201, #1246
• Workspace.add_file: Allow multiple processors to create file group folders simultaneously, #1203, #1253
• Resource Manager: Do not try to run --dump-json for known non-processors ocrd-{cis-data,import,make}, #1218, #1249
• Resource Manager: Properly handle copying of directories, #1237, #1248
• bashlib: regression in parsing JSON from introducing parameter preset files, #1258

Removed:

• Defaults for -I/--input-file-grp/-O/--output-file-grp, #1256, #274

Fixed:

• GHA Docker: build docker.io first, then tag ghcr.io

Fixed:

• OcrdFile.url can now be removed properly, #1226, #1227
• ocrd workspace find --undo-download: Only remove file refs if it's an actual download, #1150, #1235
• ocrd workspace find --undo-download: When --keep-files is not set, remove file from disk, #1150, #1235
• OCRD_LOGGING_DEBUG: Normalize/lowercase boolean values, #1230, #1231
• Workspace.download_file: Use Ocrd.local_filename if set but not already present in the FS, #1149, #1228

Changed:

• Install ocrd with pip --editable inside Docker, #1225, OCR-D/ocrd_all#416
• Reduce log spam in ocrd_network, #1222
• CI: Stop testing for 3.7, #1207, #1221

Added:

• Separate docker versions for tensorflow v1, tensorflow v2 and torch, #1186
• Processing server can serve as a proxy for METS Server TCP requests, forwarding to UDS, #1220
• ocrd workspace clean to remove "untracked", i.e. not METS-referenced, files, #1150, #1236
• -p now supports parameter preset resources in addition to raw JSON and absolute/relative paths to JSON files, #930, #969, #1238

Fixed:

• bashlib processors will download on-demand, like pythonic processors do, #1216, #1217

Changed:

• Replace distutils which equivalents from shutil for compatibility with python 3.12+, #1219
• CI: Updated GitHub actions, #1206
• CI: Fixed scrutinizer, #1217

Added:

• Integration tests for ocrd_network, #1184

Fixed:

• Broken PyPI release

Removed:

• Support for Python <= 3.7, #1207

Fixed:

• remove duplicate description of OCRD_DOWNLOAD_TIMEOUT in --help, #1204
• Use importlib_metadata shim for 3.9+, #1210, OCR-D/ocrd_froc#10