ocrd package

OCR-D reference implementation, base package: decorators and classes for processors and CLIs.

Related (and dependent) packages:

• ocrd_utils Contains utilities and constants, e.g. for logging, path normalization, coordinate calculation etc.

• ocrd_models Contains file format wrappers for PAGE-XML, METS, EXIF metadata etc.

• ocrd_modelfactory Code to instantiate models from existing data.

• ocrd_validators Schemas and routines for validating BagIt, ocrd-tool.json, workspaces, METS, page, CLI parameters etc.

Subpackages

• ocrd.cli package
  • ocrd
  • Submodules
    • ocrd.cli.bashlib module
      • ocrd bashlib
    • ocrd.cli.log module
      • ocrd log
      • LogCtx
    • ocrd.cli.network module
      • ocrd network
    • ocrd.cli.ocrd_tool module
      • ocrd ocrd-tool
      • OcrdToolCtx
    • ocrd.cli.process module
      • ocrd process
    • ocrd.cli.resmgr module
      • ocrd resmgr
      • print_resources()
    • ocrd.cli.validate module
      • ocrd validate
    • ocrd.cli.workspace module
      • ocrd workspace
      • WorkspaceCtx
    • ocrd.cli.zip module
      • ocrd zip
• ocrd.decorators package
  • ocrd_cli_wrap_processor()
  • check_and_run_network_agent()
  • Submodules
    • ocrd.decorators.loglevel_option module
      • ocrd_loglevel()
    • ocrd.decorators.mets_find_options module
      • mets_find_options()
    • ocrd.decorators.ocrd_cli_options module
      • ocrd_cli_options()
    • ocrd.decorators.parameter_option module
      • parameter_option()
      • parameter_override_option()
• ocrd.processor package
  • Subpackages
    • ocrd.processor.builtin package
      • Subpackages
      • Submodules
  • Submodules
    • ocrd.processor.base module
      • Processor
      • generate_processor_help()
      • run_cli()
      • run_processor()
    • ocrd.processor.helpers module
      • generate_processor_help()
      • run_cli()
      • run_processor()

Submodules

• ocrd.constants module
• ocrd.mets_server module
  • OcrdFileModel
    • OcrdFileModel.file_grp
    • OcrdFileModel.file_id
    • OcrdFileModel.mimetype
    • OcrdFileModel.page_id
    • OcrdFileModel.url
    • OcrdFileModel.local_filename
    • OcrdFileModel.create()
  • OcrdAgentModel
    • OcrdAgentModel.name
    • OcrdAgentModel.type
    • OcrdAgentModel.role
    • OcrdAgentModel.otherrole
    • OcrdAgentModel.othertype
    • OcrdAgentModel.notes
    • OcrdAgentModel.create()
  • OcrdFileListModel
    • OcrdFileListModel.files
    • OcrdFileListModel.create()
  • OcrdFileGroupListModel
    • OcrdFileGroupListModel.file_groups
    • OcrdFileGroupListModel.create()
  • OcrdAgentListModel
    • OcrdAgentListModel.agents
    • OcrdAgentListModel.create()
  • ClientSideOcrdMets
    • ClientSideOcrdMets.session
    • ClientSideOcrdMets.save()
    • ClientSideOcrdMets.stop()
    • ClientSideOcrdMets.reload()
    • ClientSideOcrdMets.unique_identifier
    • ClientSideOcrdMets.workspace_path
    • ClientSideOcrdMets.file_groups
    • ClientSideOcrdMets.agents
    • ClientSideOcrdMets.add_agent()
    • ClientSideOcrdMets.find_files()
    • ClientSideOcrdMets.find_all_files()
    • ClientSideOcrdMets.add_file()
  • MpxReq
    • MpxReq.save()
    • MpxReq.stop()
    • MpxReq.reload()
    • MpxReq.unique_identifier()
    • MpxReq.workspace_path()
    • MpxReq.file_groups()
    • MpxReq.agents()
    • MpxReq.add_agent()
    • MpxReq.find_files()
    • MpxReq.add_file()
  • OcrdMetsServer
    • OcrdMetsServer.create_process()
    • OcrdMetsServer.kill_process()
    • OcrdMetsServer.shutdown()
    • OcrdMetsServer.startup()
  • is_socket_in_use()
• ocrd.resolver module
  • Resolver
    • Resolver.download_to_directory()
    • Resolver.workspace_from_url()
    • Resolver.workspace_from_nothing()
    • Resolver.resolve_mets_arguments()
• ocrd.resource_manager module
  • OcrdResourceManager
    • OcrdResourceManager.userdir
    • OcrdResourceManager.xdg_data_home
    • OcrdResourceManager.xdg_config_home
    • OcrdResourceManager.save_user_list()
    • OcrdResourceManager.load_resource_list()
    • OcrdResourceManager.list_available()
    • OcrdResourceManager.list_installed()
    • OcrdResourceManager.add_to_user_database()
    • OcrdResourceManager.default_resource_dir
    • OcrdResourceManager.location_to_resource_dir()
    • OcrdResourceManager.resource_dir_to_location()
    • OcrdResourceManager.parameter_usage()
    • OcrdResourceManager.download()
• ocrd.task_sequence module
  • ProcessorTask
    • ProcessorTask.parse()
    • ProcessorTask.ocrd_tool_json
    • ProcessorTask.validate()
  • validate_tasks()
  • run_tasks()
• ocrd.workspace module
  • Workspace
    • Workspace.reload_mets()
    • Workspace.merge()
    • Workspace.download_url()
    • Workspace.download_file()
    • Workspace.remove_file()
    • Workspace.remove_file_group()
    • Workspace.rename_file_group()
    • Workspace.add_file()
    • Workspace.save_mets()
    • Workspace.resolve_image_exif()
    • Workspace.resolve_image_as_pil()
    • Workspace.image_from_page()
    • Workspace.image_from_segment()
    • Workspace.save_image_file()
    • Workspace.find_files()
• ocrd.workspace_backup module
  • WorkspaceBackup
    • WorkspaceBackup.from_path()
  • WorkspaceBackupManager
    • WorkspaceBackupManager.restore()
    • WorkspaceBackupManager.add()
    • WorkspaceBackupManager.list()
    • WorkspaceBackupManager.undo()
• ocrd.workspace_bagger module
  • WorkspaceBagger
    • WorkspaceBagger.bag()
    • WorkspaceBagger.spill()
    • WorkspaceBagger.validate()
    • WorkspaceBagger.recreate_checksums()