kcworks-import-client

Standalone Python client for importing works into KCWorks via the streamlined import API.

• Installation
  • From this repository
  • Console scripts
  • Tests
• Streamlined Import API
  • Who can use the import API?
  • The import request
  • Example import request
  • A successful import response
  • An unsuccessful import response
  • A partially successful import response
  • What happens to an import request that fails?
  • Making duplicate import requests
• Library API
  • ImportClient
  • MultiCollectionImporter
  • Public exports
• Using the single-collection importer
  • Requirements
  • Library API
  • Command-Line Arguments
  • Environment Variables
  • Usage Examples
  • Response Handling
  • Exit Codes
• Using the multi-collection importer
  • Manifest format
  • Parent / child links
  • Command-Line Arguments
  • Usage Example
• Changelog
  • 0.2.0
  • 0.1.0

What this package provides

• ImportClient — library API for single-collection imports (paths or in-memory metadata/files)

• MultiCollectionImporter — create collections from a manifest, optional parent/child links, then import each batch

• CLI entry points — kcworks-api-importer and kcworks-multi-collection-importer

The Streamlined Import API chapter includes the full usage narrative (permissions, request body, owners, identifiers, file reconciliation, and response shapes) previously kept only in the KCWorks instance docs.

Indices and tables

• Index

• Search Page