Repository files navigation

Python library and command line scripts for building Preservica V6 SubmissionInformation packages (SIPs). Preservica 6 has a flexible data model butfew client side tools that take advantage of it. Use cases such as ingestingfiles with pre-existing checksums and appending multiple content objects tosingle representations requires building XIP metadata outside of Preservica'sexisting tools. This package aims to do that in a way that's flexible andscalable for anyone with basic Python scripting knowledge.

Eventually I will package this properly. For now, clone and use within the repodirectory.

xip_builder is the central library and consists of a single class for building XIPbased packages for Preservica. The Sip class inherits fromzipfile.ZipFile. On initialisation, this class creates an empty zipfile and aroot node for XIP metadata. Methods can then be used to build the SIP hierarchy,add identifiers and metadata and write content to the zipfile in a structurethat Preservica can then interpret on ingest.Note that you will have to build the various objects in hierarchical order inorder to build the SIP structure. Add object methods return the created object'sreference UUID, that can then be appended to subsequent objects. For example:

from pyservica.xip_builder import Sipsip = Sip(sip_path, target)struct_ref = sip.add_structobj(foldername, target)asset_ref= sip.add_infobj(ident, struct_ref)sip.add_manifestation(asset_ref, filepath, 'Preservation')sip.add_manifestation(asset_ref, filepath, 'Access')sip.serialise()

The serialise() method finally writes xml metadata and closes the zipfileonce the sip structure has been finalised.

API documentation is in the API directory.

This project is in very early stages and the API will likely change frequently.