v2.70.0

Added:

• ocrd network client workflow run: Add --print-status flag to periodically print the job status, #1277
• Processing Server: DELETE /mets_server_zombies to kill any renegade METS servers, #1277
• No more zombie METS Server by properly shutting them down, #1284
• OCRD_NETWORK_RABBITMQ_HEARBEAT to allow overriding the heartbeat behavior of RabbitMQ, #1285

Changed:

• significantly more detailed logging for the METS Server and Processing Server, #1284
• Only import ocrd_network in src/ocrd/decorators/init.py once needed, #1289
• Automate release via GitHub Actions, #1290

Fixed:

• ocrd/core-cuda-torch: Install torchvision as well, #1286
• Processing Server: remove shut down METS servers from deployer's cache, #1287
• typos, #1274

v2.69.0

Fixed:

• tests: ensure ocrd_utils.config gets reset whenever changing it globally
• ocrd.cli.workspace: consistently pass on --mets-server-url and --backup
• ocrd.cli.workspace: make list-page work w/ METS Server
• ocrd.cli.validate "tasks": pass on --mets-server-url
• lib.bash: fix errexit handling
• actually apply CLI --log-filename, and show in --help
• adapt to Pillow changes
• ocrd workspace clone: do pass on --file-grp (for download filtering)
• OcrdMetsServer.add_file: pass on force kwarg
• Workspace.reload_mets: handle ClientSideOcrdMets as well
• OcrdMets.get_physical_pages: cover return_divs w/o for_fileIds and for_pageIds
• disableLogging: also re-instate root logger to Python defaults
• OcrdExif: handle multi-frame TIFFs gracefully in identify callout, #1276

Changed:

• run_processor: be robust if ocrd_tool is missing steps
• PcGtsType.PageType.id via make_xml_id: replace / with _
• ClientSideOcrdMets: use same logger name prefix as METS Server
• Processor.zip_input_files: when --page-id yields empty list, just log instead of raise

Added:

• OcrdPage: new PageType.get_ReadingOrderGroups() to retrieve recursive RO as dict
• METS Server: export and delegate physical_pages
• ocrd.cli.workspace server: add subcommands reload and save
• processor CLI: delegate --resolve-resource, too
• OcrdConfig.reset_defaults to reset config variables to their defaults
• ocrd_utils.scale_coordinates for resizing images

v3.0.0b5

Fixed:

• tests: ensure ocrd_utils.config gets reset whenever changing it globally
• OcrdMetsServer.add_file: pass on force kwarg
• ocrd.cli.workspace: consistently pass on --mets-server-url and --backup
• ocrd.cli.validate "tasks": pass on --mets-server-url
• ocrd.cli.bashlib "input-files": pass on --mets-server-url
• lib.bash input-files: pass on --mets-server-url, --overwrite, and parameters
• lib.bash: fix errexit handling
• ocrd.cli.ocrd-tool "resolve-resource": forgot to actually print result

Changed:

• 🔥 Processor / Workspace.add_file: always force if OCRD_EXISTING_OUTPUT==OVERWRITE
• 🔥 Processor.verify: revert 3.0.0b1 enforcing cardinality checks (stay backwards compatible)
• 🔥 Processor.verify: check output fileGrps, too
  (must not exist unless OCRD_EXISTING_OUTPUT=OVERWRITE|SKIP or disjoint --page-id range)
• lib.bash input-files: do not try to validate tasks here (now covered by Processor.verify())
• run_processor: be robust if ocrd_tool is missing steps
• PcGtsType.PageType.id via make_xml_id: replace / with _

Added:

• OcrdPage: new PageType.get_ReadingOrderGroups() to retrieve recursive RO as dict
• ocrd.cli.workspace server: add subcommands reload and save
• METS Server: export and delegate physical_pages
• processor CLI: delegate --resolve-resource, too
• Processor.process_page_file / OcrdPageResultImage: allow None besides AlternativeImageType

v3.0.0b4

Fixed:

• Processor.metadata_location: src workaround respects namespace packages, qurator-spk/eynollah#134
• Workspace.reload_mets: handle ClientSideOcrdMets as well

v3.0.0b3

Added:

• OcrdConfig.reset_defaults to reset config variables to their defaults

v3.0.0b2

Added:

• Processor.max_workers: class attribute to control per-page parallelism of this implementation
• Processor.max_page_seconds: class attribute to control per-page timeout of this implementation
• OCRD_MAX_PARALLEL_PAGES for whether and how many workers should process pages in parallel
• OCRD_PROCESSING_PAGE_TIMEOUT for whether and how long processors should wait for single pages
• OCRD_MAX_MISSING_OUTPUTS for maximum rate (fraction) of pages before making OCRD_MISSING_OUTPUT=abort

Fixed:

• disableLogging: also re-instate root logger to Python defaults

v3.0.0b1

Fixed:

• actuall apply CLI --log-filename
• adapt to Pillow changes
• ocrd workspace clone: do pass on --file-grp (for download filtering)

Changed:

• 🔥 ocrd_utils, ocrd_models, ocrd_modelfactory, ocrd_validators and ocrd_network are not published
  as separate packages anymore, everything is contained in ocrd - you should adapt your requirements.txt accordingly
• 🔥 Processor.parameter now a property (attribute always exists, but None for non-processing contexts)
• 🔥 Processor.parameter is now a frozendict (contents immutable)
• 🔥 Processor.parameter validate when(ever) set instead of (just) the constructor
• setting Processor.parameter will also trigger (Processor.shutdown() and) Processor.setup()`
• get_processor(... instance_caching=True): use min(max_instances, OCRD_MAX_PROCESSOR_CACHE)
• 🔥 Processor.verify always validates fileGrp cardinalities (because we have ocrd-tool.json defaults now)
• 🔥 OcrdMets.add_agent without positional arguments
• ocrd bashlib input-files now uses normal Processor decorator, and gets passed actual ocrd-tool.json and tool name
  from bashlib's ocrd__wrap

Added:

• Processor.metadata_filename: expose to make local path of ocrd-tool.json in Python distribution reusable+overridable
• Processor.metadata_location: expose to make absolute path of ocrd-tool.json reusable+overridable
• Processor.metadata_rawdict: expose to make in-memory contents of ocrd-tool.json reusable+overridable
• Processor.metadata: expose to make validated and default-expanded contents of ocrd-tool.json reusable+overridable
• Processor.shutdown: to shut down processor after processing, optional
• Processor.max_instances: class attribute to control instance caching of this implementation

v2.68.0

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

v3.0.0a2

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

v3.0.0a1

#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